Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company's banking needs and are designed to be easy to understand and implement.
We're continuously growing this library and what you see here is just the start, but if you need something specific or have a question, contact us.
license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: v2 servers: - description: Production url: https://api.synctera.com/v2 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v2 security: - bearerAuth: [] tags: - description: Request to create and manage statements name: Statements - description: Create and manage Synctera Pay templates name: SyncteraPay - description: Apple Pay APIs name: Apple Pay - description: Request to create and manage accounts name: Accounts - description: Account Template name: Account Templates - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Requests to create and manage API keys name: API Keys - description: Requests to manage banks name: Banks - description: Requests to create and manage customers name: Customers - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: > The fintech profile document resource is used to track the approval status of any documents which must be reviewed by a bank. This includes regulatory documents which will be presented to the fintech's end users, and also any documents that help the bank understand the fintech's fitness for duty. name: Fintech Profile - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: History name: History - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Requests to initiate customer verification. name: KYC/KYB Verifications - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to manage partners name: Partners - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to create and manage roles name: Roles - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: Request to create and manage users name: Users - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Retrieve user identity information name: Identity - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to configure vendors. name: Vendor Configurations - description: Requests to create and manage notes name: Notes - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Requests to create licenses name: Licenses - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Requests to search financial institutions name: Institutions (Beta) - description: Requests to manage addresses name: Addresses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Manage contacts for bank and fintech partners name: Contacts - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: Create a credit application. name: Applications (beta) - description: Billing period summaries name: Billing Period Summaries - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Billing rates name: Billing Rates - description: Rates name: Rates - description: Lending Config name: Lending Config - description: Manage credit disputes name: Credit Disputes - description: Payments related to lending accounts name: Payments - description: Tenant Config name: Tenant Config - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Autopay payment records for billing periods name: Autopays - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: Bulk card issuance name: Bulk Issuance - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: Requests to create and manage card disputes name: Card Disputes - description: Requests to simulate card payments name: Card Simulations - description: Create and manage payments name: ACH - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Create and manage holds name: Hold - description: Create and manage transactions name: Transactions - description: Create and manage transactions name: Transactions (internal) - description: Create and manage scheduled transactions name: Scheduled Transactions (internal) - description: Create and manage spending controls name: Spend Controls - description: Create and manage tenant configurations name: Tenant Configs - description: Lookup merchant information name: Merchants - description: See balance history name: BalanceHistory - description: API for effective balances name: effective_balances - description: Transaction lines API name: transactions - description: Create and manage transactions name: Transactions (beta) - description: Create and manage spending controls name: Spend Controls (beta) - description: | Requests to create and manage fees name: Fees (beta) - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Create and manage disputes name: Disputes - description: Create and manage tenant-level transaction limits name: Tenant Limits (beta) - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Manage negative balance processes name: Negative Balance - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Requests to create and manage webhooks name: Webhooks - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage documents. name: Documents - description: Request to create and manage edd name: Trust - description: Requests to calculate and manage CRR name: CRR - description: Create and manage wire transfers name: Wires - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Create and manage sweep configurations name: Configs - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests for transaction risk detection name: Transaction risk - description: Configuration and management of transaction monitoring rules name: Transaction Monitoring - description: Request to create and manage payment_schedules name: Cronut paths: /crr: summary: CRR get: tags: - CRR summary: List CRRs description: Get paginated list of CRR operationId: listCRR parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page_token' - $ref: '#/components/parameters/customer_id' - $ref: '#/components/parameters/business_id' - $ref: '#/components/parameters/include_history' responses: '200': content: application/json: schema: $ref: '#/components/schemas/crr_list' description: List of CRR for customers, or businesses '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string customer_id: description: The unique identifier of a customer. in: query name: customer_id schema: example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string business_id: description: ID of the business that the risk score applies to in: query name: business_id schema: example: edebece0-4a06-4806-b062-7de25a848be8 format: uuid type: string include_history: description: If true, include old risk scores in the response in: query name: include_history schema: default: false type: boolean schemas: crr_list: allOf: - properties: risk_scores: description: Array of risk scores items: $ref: '#/components/schemas/crr_response' type: array required: - risk_scores type: object - $ref: '#/components/schemas/paginated_response' crr_response: properties: business_id: description: >- ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both example: 06a644f6-2623-4dd2-b2cd-da8a8667515e format: uuid type: string calculated_score: description: >- The organically calculated risk score via the weighted average formula. When auto_high is triggered, risk_score is forced to 100 but this field preserves the original calculated value. example: 47 type: integer calculations_breakdown: description: >- An array that holds the calculated weights for each risk parameter that was used in the score calculation items: $ref: '#/components/schemas/calculation_breakdown' type: array creator_id: description: >- ID of the user that created risk score. creator_id will be null if score was calculated automatically example: 53869fb3-c58e-4a49-badb-7b273a7bdd34 format: uuid type: string customer_id: description: >- ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both example: 272878fe-355f-4308-8d1d-4c7d43d698f6 format: uuid type: string id: description: Risk score record unique ID example: 7503cd8a-903b-4fee-aa54-da3dc71f4124 format: uuid type: string note: description: >- The attached note for the risk score. An note is always added when a score has been overridden by a user example: Customer was found on a watchlist. Setting the risk score to 80 type: string risk_level: description: Risk score classification enum: - LOW - MEDIUM - HIGH type: string risk_score: description: >- The calculated risk score for the customer/business. When auto_high is triggered, this is forced to 100. example: 37 type: integer tenant: $ref: '#/components/schemas/tenant_id' valid_from: description: The start date that this risk score came into effect. example: '2023-01-05T11:23:34.321Z' format: date-time type: string valid_to: description: The end date that this risk score came into effect. example: '2024-01-05T11:23:34.321Z' format: date-time type: string required: - id - risk_score - risk_level - tenant type: object paginated_response: properties: next_page_token: description: >- If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows. example: a8937a0d type: string title: Paginated List response type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object calculation_breakdown: description: >- An array that holds the calculated weights for each risk parameter that was used in the score calculation properties: auto_high_risk_triggered: description: Whether this parameter triggered auto-high risk in the calculation type: boolean condition: $ref: '#/components/schemas/condition' overridden_score: description: >- Additional score points attributed from auto-high override. The remainder (100 - calculated_score) is divided evenly across all auto-high parameters. format: double type: number parameter_label: description: The user-friendly label for the parameter example: Customer Country type: string parameter_name: description: The name of the parameter that was used in the score calculation enum: - CIP - CUSTOMER_COUNTRY - CUSTOMER_TENURE - INDUSTRY - HIDTA_HIFCA - FINANCIAL_SERVICES - BUSINESS_CATEGORY - ANNUAL_INCOME - OWNERSHIP_STRUCTURE - SPECIAL_INVOLVEMENT - PEP_CLASSIFICATION - AML_CASE_DISPOSITION - ADVERSE_MEDIA - PAYMENT_TYPE - PARTNER_TYPE - TRANSACTION_GEOGRAPHY - EXTERNAL_SCORE type: string parameter_score: description: >- The calculated weight of the risk param. calculated_weight = parameter weight/sum(parameters weight) * 100 example: 46.42 format: double type: number parameter_weight: description: The weight of the risk param as defined in the risk config example: 25 type: integer required: - parameter_score - parameter_weight type: object tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string condition: description: The parameter condition was used in the score calculation properties: lower: description: >- If the condition type is RANGE. condition_lower is the field that stores the lower value of the condition example: 0 type: integer type: $ref: '#/components/schemas/condition_type' upper: description: >- If the condition type is RANGE. condition_upper is the field that stores the upper value of the condition example: 150000 type: integer value: description: >- If the condition type is CATEGORICAL. condition_value is the field that stores the discrete value type: string weight: description: | The weight of the condition as specified in the risk config. For EXTERNAL_SCORE (condition type NONE), this is the applied external score value at the time of calculation, sourced from risk_config_external_score. EXTERNAL_SCORE has no config-defined conditions. example: 75 maximum: 100 minimum: 0 type: integer required: - type - weight type: object condition_type: description: >- Conditions can be of type CATEGORICAL or RANGE where the weight is determined by the lower and upper limit fields. NONE is used for parameters like EXTERNAL_SCORE that have no conditions. enum: - CATEGORICAL - RANGE - NONE type: string responses: unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````