REST API covering Customers (Personal & Business), Accounts, Cards, Internal Transfers, Payment Schedules, ACH Payments, mRDC, KYC/KYB Verification, Document Verification, and Disclosures. Authenticated via API keys issued from the Synctera Console.
{"components":{"parameters":{"account_id_path":{"description":"Unique identifier for the account.","in":"path","name":"account_id","required":true,"schema":{"example":"12dbc24c-3cfc-46dc-a164-0977434afabf","format":"uuid","type":"string"}},"account_id_query":{"description":"Account ID(s). Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"id","required":false,"schema":{"$ref":"#/components/schemas/account_id_query_schema"},"style":"form","x-external":true},"account_id_query_array":{"description":"Account ID(s). Multiple IDs can be provided as a comma-separated list.","explode":false,"in":"query","name":"account_id","required":false,"schema":{"items":{"$ref":"#/components/schemas/account_id"},"type":"array"},"style":"form","x-external":true},"account_id_query1":{"description":"Originating account IDs. Multiple IDs can be provided as a comma-separated list.","explode":false,"in":"query","name":"account_id","required":false,"schema":{"$ref":"#/components/schemas/id_list_query_schema"},"style":"form","x-external":true},"account_id1":{"description":"The account's unique identifier provided by Synctera","in":"query","name":"account_id","required":true,"schema":{"example":"e4b92656-ef1e-41f5-a85f-af09346611c0","format":"uuid","type":"string"},"x-external":true},"account_id2":{"description":"Account ID","in":"query","name":"account_id","required":false,"schema":{"example":"d6201244-02d1-493e-87f6-a3391527abfc","format":"uuid","type":"string"},"x-external":true},"account_no":{"description":"Account number","in":"query","name":"account_no","required":false,"schema":{"type":"string"},"x-external":true},"account_number":{"description":"Account number(s). Multiple account numbers can be provided as a comma-separated list.\nWhen only a single account number is provided, any * characters in the string are wildcards, and match any characters.\n","explode":false,"in":"query","name":"account_number","required":false,"schema":{"example":"2345678108180014864","items":{"type":"string"},"type":"array"},"style":"form","x-external":true},"account_range_id":{"in":"path","name":"account_range_id","required":true,"schema":{"$ref":"#/components/schemas/account_range_id"}},"account_sort_by_query":{"description":"Specifies the sort order for the returned accounts.\n","explode":false,"in":"query","name":"sort_by","required":false,"schema":{"items":{"enum":["account_number:asc","account_number:desc","account_type:asc","account_type:desc","first_name:asc","first_name:desc","last_name:asc","last_name:desc"],"type":"string"},"type":"array"},"style":"form","x-external":true},"alert_id":{"description":"Unique identifier for this watchlist alert.","in":"path","name":"alert_id","required":true,"schema":{"example":"ff23b9d0-4e64-4b98-9f4a-3591ed08121a","format":"uuid","type":"string"}},"application_id":{"description":"The unique identifier of an external application","in":"path","name":"application_id","required":true,"schema":{"example":"4d463562-87b0-40bf-ba3f-7b52833f4898","format":"uuid","type":"string"}},"application_id_path":{"description":"Unique identifier for the application.","in":"path","name":"application_id","required":true,"schema":{"example":"2e3304dc-a1c2-427e-ac5a-a2586a95ce1f","format":"uuid","type":"string"}},"application_status":{"description":"Status of the credit application\n","in":"query","name":"status","required":false,"schema":{"$ref":"#/components/schemas/application_status"},"x-external":true},"ban_status":{"in":"query","name":"ban_status","required":false,"schema":{"$ref":"#/components/schemas/ban_status"},"x-external":true},"bin_id":{"in":"path","name":"bin_id","required":true,"schema":{"$ref":"#/components/schemas/bin_id"}},"bin_id_query_array":{"description":"The unique identifier of a bin.","explode":false,"in":"query","name":"bin_id","required":false,"schema":{"items":{"$ref":"#/components/schemas/bin_id"},"type":"array"},"style":"form","x-external":true},"business_id_path":{"description":"Business's unique identifier.","in":"path","name":"business_id","required":true,"schema":{"example":"21b74a02-b7c7-49f4-a497-98ba5cbedb27","format":"uuid","type":"string"}},"business_id_query":{"description":"Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"business_id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"business_id_query_array":{"description":"A list of business unique identifiers, with a comma separating any values.","explode":false,"in":"query","name":"business_id","required":false,"schema":{"items":{"$ref":"#/components/schemas/business_id2"},"type":"array"},"style":"form","x-external":true},"business_id_query1":{"in":"query","name":"business_id","required":false,"schema":{"$ref":"#/components/schemas/business_id"},"x-external":true},"business_sort_by_query":{"description":"Specifies the sort order for the returned businesses.\n","explode":false,"in":"query","name":"sort_by","required":false,"schema":{"items":{"enum":["entity_name:asc","entity_name:desc"],"type":"string"},"type":"array"},"style":"form","x-external":true},"card_brand_query":{"description":"The brand of a card product","in":"query","name":"card_brand","required":false,"schema":{"$ref":"#/components/schemas/card_brand"},"x-external":true},"card_id":{"in":"path","name":"card_id","required":true,"schema":{"$ref":"#/components/schemas/card_id"}},"card_id_query":{"in":"query","name":"card_id","required":false,"schema":{"$ref":"#/components/schemas/card_id"},"x-external":true},"card_image_id":{"in":"path","name":"card_image_id","required":true,"schema":{"$ref":"#/components/schemas/card_image_id"}},"card_product_id":{"in":"path","name":"card_product_id","required":true,"schema":{"$ref":"#/components/schemas/card_product_id"}},"card_product_id_query":{"in":"query","name":"card_product_id","required":false,"schema":{"$ref":"#/components/schemas/card_product_id"},"x-external":true},"card_program_id":{"in":"path","name":"card_program_id","required":true,"schema":{"$ref":"#/components/schemas/card_program_id"}},"card_sort_by_query":{"description":"Specifies the sort order for the returned cards.\n","explode":false,"in":"query","name":"sort_by","required":false,"schema":{"items":{"enum":["account_id:asc","account_id:desc","customer_id:asc","customer_id:desc","card_product_id:asc","card_product_id:desc","last_four:asc","last_four:desc","card_type:asc","card_type:desc","card_brand:asc","card_brand:desc","expiration_date:asc","expiration_date:desc","form:asc","form:desc","card_status:asc","card_status:desc"],"type":"string"},"type":"array"},"style":"form","x-external":true},"card_status_query":{"description":"The status of a card","in":"query","name":"card_status","required":false,"schema":{"$ref":"#/components/schemas/card_status"},"x-external":true},"card_type_query":{"description":"Indicates the type of card","in":"query","name":"card_type","required":false,"schema":{"enum":["DEBIT"],"type":"string"},"x-external":true},"customer_id":{"in":"query","name":"customer_id","required":false,"schema":{"example":"3b601be1-1c91-4136-bca8-6754cc78f713","format":"uuid","type":"string"},"x-external":true},"customer_id_path":{"description":"The customer's unique identifier","in":"path","name":"customer_id","required":true,"schema":{"$ref":"#/components/schemas/customer_id"}},"customer_id_query":{"in":"query","name":"customer_id","required":false,"schema":{"$ref":"#/components/schemas/customer_id1"},"x-external":true},"customer_id_query_array":{"description":"A list of customer unique identifiers, with a comma separating any values.","explode":false,"in":"query","name":"customer_id","required":false,"schema":{"items":{"$ref":"#/components/schemas/customer_id"},"type":"array"},"style":"form","x-external":true},"customer_id_query_array1":{"explode":false,"in":"query","name":"customer_id","required":false,"schema":{"items":{"$ref":"#/components/schemas/customer_id1"},"type":"array"},"style":"form","x-external":true},"customer_id_query_one":{"deprecated":true,"description":"The customer's unique identifier","in":"query","name":"customer_id","required":false,"schema":{"$ref":"#/components/schemas/customer_id"},"x-external":true},"customer_id_query_required":{"in":"query","name":"customer_id","required":true,"schema":{"$ref":"#/components/schemas/customer_id1"},"x-external":true},"customer_id_query1":{"description":"The IDs of customers who created the payment schedules. Multiple IDs can be provided as a comma-separated list.","explode":false,"in":"query","name":"customer_id","required":false,"schema":{"$ref":"#/components/schemas/id_list_query_schema"},"style":"form","x-external":true},"customer_sort_by_query":{"description":"Specifies the sort order for the returned customers.\n","explode":false,"in":"query","name":"sort_by","required":false,"schema":{"items":{"enum":["creation_time:asc","creation_time:desc","last_updated_time:asc","last_updated_time:desc","first_name:asc","first_name:desc","last_name:asc","last_name:desc"],"type":"string"},"type":"array"},"style":"form","x-external":true},"customer_type":{"description":"Customer type of the account, BUSINESS or PERSONAL\n","in":"query","name":"customer_type","schema":{"$ref":"#/components/schemas/customer_type"},"x-external":true},"debit_network_id":{"in":"path","name":"debit_network_id","required":true,"schema":{"$ref":"#/components/schemas/debit_network_id"}},"deposit_id_path":{"description":"ID of a deposit for a remote deposit capture","in":"path","name":"deposit_id","required":true,"schema":{"example":"1985f769-dd31-4128-95db-f765355e6631","format":"uuid","type":"string"}},"digital_wallet_token_id":{"in":"path","name":"digital_wallet_token_id","required":true,"schema":{"$ref":"#/components/schemas/digital_wallet_token_id"}},"digital_wallet_token_state_query":{"description":"The status of the Digital Wallet Token","in":"query","name":"token_state","required":false,"schema":{"$ref":"#/components/schemas/digital_wallet_token_state"},"x-external":true},"disclosure_id":{"description":"The unique identifier for the disclosure.","in":"path","name":"disclosure_id","required":true,"schema":{"example":"3fa12d3f-6436-482c-a8a1-d65e9761dc2d","format":"uuid","type":"string"}},"document_id":{"description":"The unique identifier of a document.","in":"path","name":"document_id","required":true,"schema":{"example":"dd8cd509-ce52-4990-8f84-316558e68e9a","format":"uuid","type":"string"}},"email":{"in":"query","name":"email","required":false,"schema":{"description":"Only return resources where the email field matches the specified string. Any * characters in the string are wildcards, and match any characters.","example":"[email protected]","type":"string"},"x-external":true},"emboss_name_query":{"description":"emboss name","in":"query","name":"emboss_name","required":false,"schema":{"type":"string"},"x-external":true},"employment_id":{"description":"Unique ID for the employment record.","in":"path","name":"employment_id","required":true,"schema":{"example":"4675ebf0-0691-4a2b-b1db-7ca6f4ff9ec5","format":"uuid","type":"string"}},"entity_name":{"in":"query","name":"entity_name","required":false,"schema":{"description":"Only return resources where the `entity_name` field matches the specified string. Any `*` characters in the string are wildcards, and match any characters.","example":"Apex Corporation","type":"string"},"x-external":true},"expiration_date_query":{"description":"The date representing when the card would expire at","in":"query","name":"expiration_date","required":false,"schema":{"example":"2006-01-02","format":"date","type":"string"},"x-external":true},"external_account_id":{"description":"External Account ID","in":"path","name":"external_account_id","required":true,"schema":{"example":"63ea71cb-7f86-44c1-956b-77f6cbd6ecf7","format":"uuid","type":"string"}},"external_card_id":{"description":"The unique identifier of an external card","in":"path","name":"external_card_id","required":true,"schema":{"example":"411e5190-c495-4344-9fb5-0a3c7bab0345","format":"uuid","type":"string"}},"external_card_id_query":{"in":"query","name":"external_card_id","required":false,"schema":{"$ref":"#/components/schemas/external_card_id"},"x-external":true},"external_transfer_type_query":{"description":"The type of an external transfer","in":"query","name":"type","required":false,"schema":{"$ref":"#/components/schemas/transfer_type"},"x-external":true},"first_name":{"in":"query","name":"first_name","required":false,"schema":{"description":"Only return resources where the first_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.","example":"Alice","type":"string"},"x-external":true},"form_query":{"description":"The format of the card","in":"query","name":"form","required":false,"schema":{"$ref":"#/components/schemas/form"},"x-external":true},"from_business_id_query":{"description":"Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"from_business_id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"from_date":{"description":"Only display transactions with a posting date greater than from_date","in":"query","name":"from_date","required":false,"schema":{"format":"date","type":"string"},"x-external":true},"from_person_id_query":{"description":"Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"from_person_id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"gateway_id":{"in":"path","name":"gateway_id","required":true,"schema":{"$ref":"#/components/schemas/gateway_id"}},"id":{"description":"Unique resource identifier","explode":false,"in":"query","name":"id","required":false,"schema":{"items":{"example":"81026fb3-d06c-4b37-80da-2b17b4749a3f","format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"id_query":{"description":"Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"id_query1":{"description":"Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"id_query2":{"description":"IDs. Multiple IDs can be provided as a comma-separated list.","explode":false,"in":"query","name":"id","required":false,"schema":{"$ref":"#/components/schemas/id_list_query_schema"},"style":"form","x-external":true},"id_query3":{"description":"Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"id_query4":{"description":"Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"id1":{"description":"Transaction ID","in":"path","name":"id","required":true,"schema":{"example":"69c8bfb7-a0ab-4b55-9f2b-6d8065d71220","format":"uuid","type":"string"}},"idempotency_key":{"description":"An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key","in":"header","name":"Idempotency-Key","required":false,"schema":{"example":"df122e6f-2ba8-48a5-9508-4350bba5f27e","type":"string"},"x-external":true},"include_history":{"description":"If true, include old (inactive) records as well.","in":"query","name":"include_history","required":false,"schema":{"default":false,"type":"boolean"},"x-external":true},"interest_product_id_query":{"description":"Interest product ID that accounts associate with. Multiple IDs can be provided as a comma-separated list.","in":"query","name":"interest_product_id","required":false,"schema":{"type":"string"},"x-external":true},"internal_account_id_path":{"description":"Unique identifier for the internal account.","in":"path","name":"internal_account_id","required":true,"schema":{"example":"1eec6d0a-94b3-422d-bfc5-938ebff87fb0","format":"uuid","type":"string"}},"internal_account_id_query":{"description":"Internal account ID(s). Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"id","required":false,"schema":{"$ref":"#/components/schemas/account_id_query_schema"},"style":"form","x-external":true},"is_customer":{"description":"If true, show only customers. If false, show non-customer parties.","in":"query","name":"is_customer","required":false,"schema":{"type":"boolean"},"x-external":true},"last_four_query":{"description":"The last 4 digits of the card PAN","in":"query","name":"last_four","required":false,"schema":{"example":"1234","pattern":"^\\d{4}$","type":"string"},"x-external":true},"last_name":{"in":"query","name":"last_name","required":false,"schema":{"description":"Only return resources where the last_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.","example":"Smith","type":"string"},"x-external":true},"limit":{"in":"query","name":"limit","required":false,"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.\n","example":100,"minimum":1,"type":"integer"},"x-external":true},"linked_account_id_query":{"description":"Return only resources that are linked to the specified backing account in balance_floor or balance_ceiling. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"linked_account_id","required":false,"schema":{"$ref":"#/components/schemas/account_id_query_schema"},"style":"form","x-external":true},"max_age":{"description":"Optional relative age of a balance in seconds. If the balance is older than the requested seconds it will fail. This field is optional for most financial institutions, but required for some, so you should probably send it.\n","in":"query","name":"max_age","required":false,"schema":{"example":437,"format":"int64","minimum":1,"type":"integer"},"x-external":true},"monitoring_alert_id":{"description":"Unique identifier for this monitoring alert.","in":"path","name":"alert_id","required":true,"schema":{"example":"4a09a067-2f01-475d-bc62-50f245536017","format":"uuid","type":"string"}},"monitoring_subscription_id":{"description":"Unique identifier for monitoring subscription.","in":"path","name":"subscription_id","required":true,"schema":{"example":"d3682b94-3a25-41ee-8358-2308cb4a71b1","format":"uuid","type":"string"}},"originating_account_id":{"in":"query","name":"originating_account_id","required":false,"schema":{"example":"1a43dcf4-97b8-4522-850d-4de9061cf1b4","format":"uuid","type":"string"},"x-external":true},"originating_account_id_query_array":{"explode":false,"in":"query","name":"originating_account_id","required":false,"schema":{"items":{"$ref":"#/components/schemas/originating_account_id"},"type":"array"},"style":"form","x-external":true},"overdraft_account_id_query":{"deprecated":true,"description":"Overdraft account ID(s). Multiple IDs can be provided as a comma-separated list.\nThis parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.\n","explode":false,"in":"query","name":"overdraft_account_id","required":false,"schema":{"$ref":"#/components/schemas/account_id_query_schema"},"style":"form","x-external":true},"overflow_account_id_query":{"deprecated":true,"description":"Overflow account ID(s). Multiple IDs can be provided as a comma-separated list.\nThis parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.\n","explode":false,"in":"query","name":"overflow_account_id","required":false,"schema":{"$ref":"#/components/schemas/account_id_query_schema"},"style":"form","x-external":true},"page_token":{"in":"query","name":"page_token","required":false,"schema":{"description":"Optional pagination token to be provided to retrieve subsequent pages, returned from previous get","example":"h50ffqz9q5","type":"string"},"x-external":true},"payment_schedule_id_query":{"description":"Payment schedule IDs. Multiple IDs can be provided as a comma-separated list.","explode":false,"in":"query","name":"schedule_id","required":false,"schema":{"$ref":"#/components/schemas/id_list_query_schema"},"style":"form","x-external":true},"person_id_path":{"description":"Person's unique identifier.","in":"path","name":"person_id","required":true,"schema":{"example":"491b33fd-182c-4f0b-90d4-f2f929bbb6d9","format":"uuid","type":"string"}},"person_id_query":{"description":"Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"person_id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"person_sort_by_query":{"description":"Specifies the sort order for the returned persons.\n","explode":false,"in":"query","name":"sort_by","required":false,"schema":{"items":{"enum":["first_name:asc","first_name:desc","last_name:asc","last_name:desc","creation_time:asc","creation_time:desc","last_updated_time:asc","last_updated_time:desc"],"type":"string"},"type":"array"},"style":"form","x-external":true},"phone_number":{"in":"query","name":"phone_number","required":false,"schema":{"description":"Only return resources where the phone_number field matches the specified string. Phone numbers use the E.164 format e.g. +19178675309. Any * characters in the string are wildcards, and match any characters.","example":"+12065550100","type":"string"},"x-external":true},"postal_code_query":{"description":"The postal code of a card user","in":"query","name":"postal_code","required":false,"schema":{"example":"49633","type":"string"},"x-external":true},"product_id":{"description":"Account Product ID","in":"path","name":"product_id","required":true,"schema":{"example":"95a2e06d-83ab-458b-b3b8-962941411ee6","format":"uuid","type":"string"}},"prospect_id":{"description":"The unique identifier of a prospect on the waitlist","in":"path","name":"prospect_id","required":true,"schema":{"format":"uuid","type":"string"}},"receiving_account_id":{"in":"query","name":"receiving_account_id","required":false,"schema":{"example":"2c0b200c-7b43-4110-83f4-79370103ded8","format":"uuid","type":"string"},"x-external":true},"reconciliation_id":{"description":"Reconciliation id","in":"path","name":"reconciliation_id","required":true,"schema":{"example":"6917767f-50b9-475e-91c0-ed7d1efc8e13","format":"uuid","type":"string"}},"relationship_id":{"description":"Relationship ID of the account associate with the account entity","in":"path","name":"relationship_id","required":true,"schema":{"example":"1558a413-6b1c-45e0-8da0-386ae5b46b75","format":"uuid","type":"string"}},"relationship_id1":{"description":"Relationship ID.","in":"path","name":"relationship_id","required":true,"schema":{"example":"858f5a31-2723-452d-9cdc-b2c01d40d9dd","format":"uuid","type":"string"}},"relationship_type":{"description":"The relationship type. Any of the following:\n* `BENEFICIAL_OWNER_OF` – a person who directly or indirectly owns a portion of the business.\n* `MANAGING_PERSON_OF` – a person who is an officer, director, or other notable person of an organization.\n* `OWNER_OF` – a business with ownership of another business.\n","explode":false,"in":"query","name":"relationship_type","required":false,"schema":{"items":{"enum":["BENEFICIAL_OWNER_OF","MANAGING_PERSON_OF","OWNER_OF"],"example":"BENEFICIAL_OWNER_OF","format":"enum","type":"string"},"type":"array"},"style":"form","x-external":true},"result_query":{"description":"The result of the verification that was run on the party. Multiple values can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"result","required":false,"schema":{"items":{"$ref":"#/components/schemas/verification_result"},"type":"array"},"style":"form","x-external":true},"risk_rating_id":{"description":"Risk Rating ID","in":"path","name":"risk_rating_id","required":true,"schema":{"example":"25ae35db-92b9-4b74-82d9-140a07eece71","format":"uuid","type":"string"}},"schedule_id_path":{"description":"Payment schedule ID","in":"path","name":"payment_schedule_id","required":true,"schema":{"format":"uuid","type":"string"}},"ssn_last_4":{"in":"query","name":"ssn_last_4","required":false,"schema":{"description":"Only return resources where the last 4 characters of the SSN match the specified value.","example":"6789","maxLength":4,"minLength":4,"type":"string"},"x-external":true},"statement_id":{"description":"The unique identifier of a statement","in":"path","name":"statement_id","required":true,"schema":{"example":"1dac8580-6815-4c9f-be84-ac5518a46832","format":"uuid","type":"string"},"x-external":true},"status":{"in":"query","name":"status","required":false,"schema":{"$ref":"#/components/schemas/status"},"x-external":true},"status1":{"in":"query","name":"status","required":false,"schema":{"description":"Status of the business. One of the following:\n* `PROSPECT` – a potential customer, used for information-gathering and disclosures.\n* `ACTIVE` – is an integrator defined status. Integrators should set a business to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the business is eligible for specific actions such as initiating transactions or issuing a card.\n* `FROZEN` – business's actions are blocked for security, legal, or other reasons.\n* `SANCTION` – business is on a sanctions list and should be carefully monitored.\n* `DISSOLVED` – an inactive status indicating a business entity has filed articles of dissolution or a certificate of termination to terminate its existence.\n* `CANCELLED` – an inactive status indicating that a business entity has filed a cancellation or has failed to file its periodic report after notice of forfeiture of its rights to do business.\n* `SUSPENDED` – an inactive status indicating that the business entity has lost the right to operate in it's registered jurisdiction.\n* `MERGED` – an inactive status indicating that the business entity has terminated existence by merging into another entity.\n* `INACTIVE` – an inactive status indicating that the business entity is no longer active.\n* `CONVERTED` – An inactive status indicating that the business entity has been converted to another type of business entity in the same jurisdiction.\n","enum":["PROSPECT","ACTIVE","FROZEN","SANCTION","DISSOLVED","CANCELLED","SUSPENDED","MERGED","INACTIVE","CONVERTED"],"type":"string"},"x-external":true},"status2":{"in":"query","name":"status","required":false,"schema":{"description":"Only return resources where with the specified status.","enum":["ACTIVE","DECEASED","DENIED","DORMANT","ESCHEAT","FROZEN","INACTIVE","PROSPECT","SANCTION"],"example":"ACTIVE","type":"string"},"x-external":true},"status3":{"in":"query","name":"status","required":false,"schema":{"$ref":"#/components/schemas/status1"},"x-external":true},"status4":{"description":"The status of the transaction","in":"query","name":"status","required":false,"schema":{"default":"PENDING","type":"string"},"x-external":true},"status6":{"in":"query","name":"status","required":false,"schema":{"description":"Optional query parameter that can be use to filter the list of returned wires by transfer status","enum":["PENDING","COMPLETED","CANCELLED"],"example":"PENDING","type":"string"},"x-external":true},"subscription_id":{"description":"Watchlist monitoring subscription ID","in":"path","name":"subscription_id","required":true,"schema":{"example":"ddcacaa4-e0e4-4652-ae9f-5ef7f1b7d7e1","format":"uuid","type":"string"}},"subtype":{"description":"Only display transactions matching the given subtype","in":"query","name":"subtype","required":false,"schema":{"type":"string"},"x-external":true},"template_id":{"description":"Account Template ID","in":"path","name":"template_id","required":true,"schema":{"example":"72aad5e2-302a-4683-8d33-2510afae6eab","format":"uuid","type":"string"}},"to_business_id_query":{"description":"Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"to_business_id","required":false,"schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"style":"form","x-external":true},"to_date":{"description":"Only display transactions with a posting date less than or equal to to_date","in":"query","name":"to_date","required":false,"schema":{"format":"date","type":"string"},"x-external":true},"transaction_id":{"description":"Transaction ID in the ledger","in":"path","name":"transaction_id","required":true,"schema":{"example":"0cf88729-42fe-482d-904f-2f0508252858","format":"uuid","type":"string"}},"transaction_id1":{"description":"Only display holds linked to the provided transaction id","in":"query","name":"transaction_id","required":false,"schema":{"example":"cc89a467-e868-4281-b015-d95830a312eb","format":"uuid","type":"string"},"x-external":true},"transfer_id":{"description":"The unique identifier of a transfer","in":"path","name":"transfer_id","required":true,"schema":{"example":"1b7767fe-7dcd-43d5-85cf-c4392bb3e830","format":"uuid","type":"string"}},"type":{"description":"Only display transactions matching the given type","in":"query","name":"type","required":false,"schema":{"type":"string"},"x-external":true},"vendor_id":{"description":"Vendor ID","in":"path","name":"vendor_id","required":true,"schema":{"format":"string","type":"string"}},"verification_id":{"description":"Unique identifier for the verification.","in":"path","name":"verification_id","required":true,"schema":{"example":"50653b5a-fba5-4e95-aef3-819414206d61","format":"uuid","type":"string"}},"verification_id1":{"description":"Verification's unique identifier.","in":"path","name":"verification_id","required":true,"schema":{"example":"1b0cb707-c399-4210-9a83-0834fc6d6aa5","format":"uuid","type":"string"}},"verification_type_query":{"description":"The type of verification run. Multiple values can be provided as a comma-separated list.\n","explode":false,"in":"query","name":"verification_type","required":false,"schema":{"items":{"$ref":"#/components/schemas/verification_type1"},"type":"array"},"style":"form","x-external":true},"waitlist_id":{"description":"The unique identifier of a waitlist","in":"path","name":"waitlist_id","required":true,"schema":{"format":"uuid","type":"string"}},"webhook_id":{"description":"The unique identifier of a webhook","in":"path","name":"webhook_id","required":true,"schema":{"example":"8c4925a6-723f-4aa7-8c68-e36e323245e8","format":"uuid","type":"string"}},"webhook_id1":{"description":"Webhook ID","in":"path","name":"webhook_id","required":true,"schema":{"example":"97e074c8-188e-4cfb-8e34-16099909c595","format":"uuid","type":"string"}},"wire_id":{"description":"The unique identifier of a wire","in":"path","name":"wire_id","required":true,"schema":{"example":"e7c5e3cb-0294-4243-b418-47025997de7f","format":"uuid","type":"string"}}},"responses":{"account_closed":{"content":{"application/problem+jso
# --- truncated at 32 KB (443 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synctera/refs/heads/main/openapi/synctera-openapi.json