{"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":"john.doe@example.com","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+json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Account has been closed"},"already_exists":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Resource already exists error"},"bad_request":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"BadRequest"},"delete_response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_response"}}},"description":"Resource has been deleted"},"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"},"not_found":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Resource not found"},"unauthorized":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Unauthorized"},"unprocessable_entity":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Unprocessable entity request response"}},"schemas":{"account":{"anyOf":[{"$ref":"#/components/schemas/account_depository"},{"$ref":"#/components/schemas/account_line_of_credit"}],"description":"Account","type":"object"},"account_access_status":{"description":"Access status for account. Default ACTIVE","enum":["ACTIVE","FROZEN"],"type":"string"},"account_base":{"properties":{"access_status":{"$ref":"#/components/schemas/account_access_status"},"account_number":{"description":"Account number","maxLength":50,"readOnly":true,"type":"string"},"account_number_masked":{"description":"The response will contain the bank fintech ID (3 or 6 digits) plus the last 4 digits, with the digits in between replaced with * characters. Shadow mode account numbers will not be masked.","example":"123*****6789","maxLength":50,"readOnly":true,"type":"string"},"account_purpose":{"description":"Purpose of the account","example":"This account for the account holder's salary deposit.","type":"string"},"account_type":{"$ref":"#/components/schemas/account_type"},"application_id":{"description":"The application ID for this account.\n","format":"uuid","type":"string"},"balances":{"description":"A list of balances for account based on different type","items":{"$ref":"#/components/schemas/balance"},"readOnly":true,"type":"array"},"bank_routing":{"description":"Bank routing number","maxLength":9,"readOnly":true,"type":"string"},"creation_time":{"description":"Account creation timestamp in RFC3339 format","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD","example":"SVC","pattern":"^[A-Z]{3}$","type":"string"},"customer_ids":{"description":"A list of the customer IDs of the account holders.","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"customer_type":{"$ref":"#/components/schemas/customer_type"},"exchange_rate_type":{"description":"Exchange rate type","example":"M, INTERBANK, CUST","maxLength":10,"type":"string"},"iban":{"description":"International bank account number","maxLength":34,"type":"string"},"id":{"description":"Account ID","format":"uuid","readOnly":true,"type":"string"},"is_account_pool":{"description":"Account is investment (variable balance) account or a multi-balance account pool. Default false","type":"boolean"},"is_ach_enabled":{"description":"A flag to indicate whether ACH transactions are enabled.","readOnly":true,"type":"boolean"},"is_card_enabled":{"description":"A flag to indicate whether card transactions are enabled.","readOnly":true,"type":"boolean"},"is_p2p_enabled":{"description":"A flag to indicate whether P2P transactions are enabled.","readOnly":true,"type":"boolean"},"is_wire_enabled":{"description":"A flag to indicate whether wire transactions are enabled.","readOnly":true,"type":"boolean"},"last_updated_time":{"description":"Timestamp of the last account modification in RFC3339 format","format":"date-time","readOnly":true,"type":"string"},"metadata":{"description":"User provided account metadata","type":"object"},"nickname":{"description":"User provided account nickname","type":"string"},"status":{"$ref":"#/components/schemas/status"},"swift_code":{"description":"SWIFT code","maxLength":11,"minLength":8,"type":"string"}},"type":"object"},"account_creation":{"allOf":[{"$ref":"#/components/schemas/account"},{"properties":{"account_template_id":{"description":"Account template ID","format":"uuid","type":"string"},"relationships":{"description":"List of the relationship for this account to the parties","items":{"$ref":"#/components/schemas/relationship"},"type":"array"}},"type":"object"}]},"account_depository":{"allOf":[{"$ref":"#/components/schemas/account_base"},{"properties":{"balance_ceiling":{"$ref":"#/components/schemas/balance_ceiling"},"balance_floor":{"$ref":"#/components/schemas/balance_floor"},"fee_product_ids":{"description":"A list of fee account products that the current account associates with.","items":{"format":"uuid","type":"string"},"type":"array"},"interest_product_id":{"description":"An interest account product that the current account associates with. The account product must have its calculation_method set to COMPOUNDED_MONTHLY.\n","format":"uuid","type":"string"},"overdraft_limit":{"description":"Account's overdraft limit","format":"int64","minimum":0,"type":"integer"},"spending_limits":{"$ref":"#/components/schemas/spending_limits"}}}],"description":"Account representing either a checking or saving account.","type":"object"},"account_generic_response":{"properties":{"access_status":{"$ref":"#/components/schemas/account_access_status"},"access_status_last_updated_time":{"description":"Timestamp of the last modification of the access_status. RFC3339 format.","format":"date-time","readOnly":true,"type":"string"},"account_number":{"description":"Account number","maxLength":50,"readOnly":true,"type":"string"},"account_number_masked":{"description":"The response will contain the bank fintech ID (3 or 6 digits) plus the last 4 digits, with the digits in between replaced with * characters. Shadow mode account numbers will not be masked.","example":"123*****6789","maxLength":50,"readOnly":true,"type":"string"},"account_purpose":{"description":"Purpose of the account","example":"This account for the account holder's salary deposit.","type":"string"},"account_type":{"$ref":"#/components/schemas/account_type"},"application_id":{"description":"The application ID for this account.\n","format":"uuid","type":"string"},"balance_ceiling":{"$ref":"#/components/schemas/balance_ceiling"},"balance_floor":{"$ref":"#/components/schemas/balance_floor"},"balances":{"description":"A list of balances for account based on different type","items":{"$ref":"#/components/schemas/balance"},"readOnly":true,"type":"array"},"bank_routing":{"description":"Bank routing number","maxLength":9,"readOnly":true,"type":"string"},"billing_period":{"$ref":"#/components/schemas/billing_period"},"business_ids":{"description":"A list of the business IDs of the account holders.","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"chargeoff_period":{"default":90,"description":"The number of days an account can stay delinquent before marking an account as charged-off.\n","minimum":0,"type":"integer"},"creation_time":{"description":"Account creation timestamp in RFC3339 format","format":"date-time","readOnly":true,"type":"string"},"credit_limit":{"description":"The credit limit for this line of credit account in cents. Minimum is 0.\n","example":2500,"format":"int64","minimum":0,"type":"integer"},"currency":{"description":"Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD","example":"MZN","pattern":"^[A-Z]{3}$","type":"string"},"customer_ids":{"description":"A list of the customer IDs of the account holders.","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"customer_type":{"$ref":"#/components/schemas/customer_type"},"delinquency_period":{"default":30,"description":"The number of days past the due date to wait for a minimum payment before marking an account as delinquent.\n","minimum":0,"type":"integer"},"exchange_rate_type":{"description":"Exchange rate type","example":"M, INTERBANK, CUST","maxLength":10,"type":"string"},"fee_product_ids":{"description":"A list of fee account products that the current account associates with.","items":{"format":"uuid","type":"string"},"type":"array"},"grace_period":{"description":"The number of days past the billing period to allow for payment before it is considered due. This directly infers the due date for a payment.\n","example":25,"minimum":0,"type":"integer"},"iban":{"description":"International bank account number","maxLength":34,"type":"string"},"id":{"description":"Account ID","format":"uuid","readOnly":true,"type":"string"},"interest_product_id":{"description":"An interest account product that the current account associates with.","format":"uuid","type":"string"},"is_account_pool":{"description":"Account is investment (variable balance) account or a multi-balance account pool. Default false","type":"boolean"},"is_ach_enabled":{"description":"A flag to indicate whether ACH transactions are enabled.","readOnly":true,"type":"boolean"},"is_card_enabled":{"description":"A flag to indicate whether card transactions are enabled.","readOnly":true,"type":"boolean"},"is_p2p_enabled":{"description":"A flag to indicate whether P2P transactions are enabled.","readOnly":true,"type":"boolean"},"is_wire_enabled":{"description":"A flag to indicate whether wire transactions are enabled.","readOnly":true,"type":"boolean"},"last_updated_time":{"description":"Timestamp of the last account modification in RFC3339 format","format":"date-time","readOnly":true,"type":"string"},"metadata":{"description":"User provided account metadata","type":"object"},"minimum_payment":{"$ref":"#/components/schemas/minimum_payment"},"nickname":{"description":"User provided account nickname","type":"string"},"overdraft_limit":{"description":"Account's overdraft limit","format":"int64","minimum":0,"type":"integer"},"spending_limits":{"$ref":"#/components/schemas/spending_limits"},"status":{"$ref":"#/components/schemas/status"},"swift_code":{"description":"SWIFT code","maxLength":11,"minLength":8,"type":"string"}},"type":"object"},"account_id":{"description":"The unique identifier of an account","example":"4403f645-c2e3-4f8d-9027-127dca09f353","format":"uuid","type":"string"},"account_id_query_schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"account_identifiers":{"properties":{"iban":{"description":"The IBAN of the account. Value may be masked, in which case only the last four digits are returned.\n","example":"CY06470650023917R423TV710402","type":"string"},"number":{"description":"The account number. Value may be masked, in which case only the last four digits are returned.\n","example":"78277121","type":"string"}},"required":["number"],"title":"Identifiers for the account","type":"object"},"account_line_of_credit":{"allOf":[{"$ref":"#/components/schemas/account_base"},{"properties":{"chargeoff_period":{"default":90,"description":"The number of days an account can stay delinquent before marking an account as charged-off.\n","minimum":0,"type":"integer"},"credit_limit":{"description":"The credit limit for this line of credit account in cents. Minimum is 0.\n","example":2500,"format":"int64","minimum":0,"type":"integer"},"delinquency_period":{"default":30,"description":"The number of days past the due date to wait for a minimum payment before marking an account as delinquent.\n","minimum":0,"type":"integer"},"grace_period":{"description":"The number of days past the billing period to allow for payment before it is considered due. This directly infers the due date for a payment.\n","example":25,"minimum":0,"type":"integer"},"interest_product_id":{"description":"An interest account product that the current account associates with. The account product must have its calculation_method set to COMPOUNDED_DAILY.\n","format":"uuid","type":"string"},"minimum_payment":{"$ref":"#/components/schemas/minimum_payment"}},"type":"object"}],"description":"Account representing a line of credit account.","type":"object"},"account_list":{"allOf":[{"properties":{"accounts":{"description":"Array of Accounts","items":{"$ref":"#/components/schemas/account_generic_response"},"type":"array"}},"required":["accounts"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"account_product":{"discriminator":{"mapping":{"FEE":"#/components/schemas/fee","INTEREST":"#/components/schemas/interest"},"propertyName":"product_type"},"oneOf":[{"$ref":"#/components/schemas/interest"},{"$ref":"#/components/schemas/fee"}],"type":"object"},"account_product_list":{"allOf":[{"properties":{"account_products":{"description":"Array of account products","items":{"$ref":"#/components/schemas/account_product"},"type":"array"}},"required":["account_products"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"account_range":{"properties":{"account_range":{"items":{"example":[2222222200,2222222210],"format":"int64","maxLength":2,"minLength":2,"type":"integer"},"type":"array"},"bank_id":{"description":"The bank ID","type":"integer"},"bin_id":{"description":"The ID of the BIN this account range belogns to","example":"3d911b32-5b2b-4d7f-80fa-9ba6ba1b9030","format":"uuid","type":"string"},"creation_time":{"description":"The timestamp representing when the account range was created","example":"Sat Jan 08 2022 23:14:44 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"end_date":{"description":"The time when account range becomes inactive","example":"Tue Jan 10 2023 05:33:30 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"id":{"description":"Account Range Id","example":"5ccafc74-3c14-42c7-8794-a6ff9ba9ffd2","format":"uuid","readOnly":true,"type":"string"},"is_tokenization_enabled":{"default":false,"description":"Controls whether account range allows tokenization","example":false,"type":"boolean"},"last_modified_time":{"description":"The timestamp representing when the account range was last modified","example":"Mon Dec 20 2021 23:22:49 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"partner_id":{"description":"The partner ID","type":"integer"},"physical_card_format":{"$ref":"#/components/schemas/physical_card_format"},"start_date":{"description":"The time when account range becomes active","example":"Fri Dec 24 2021 21:53:48 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"required":["bank_id","partner_id","bin_id","account_range"],"type":"object"},"account_range_id":{"description":"The unique identifier of a account range","example":"bc106517-e026-40f0-85a5-ff17a2d792d0","format":"uuid","type":"string"},"account_range_response":{"allOf":[{"$ref":"#/components/schemas/account_range"}],"required":["id","bank_id","partner_id","bin_id","account_range","is_tokenization_enabled","creation_time","last_modified_time"]},"account_range_response_list":{"allOf":[{"properties":{"account_ranges":{"description":"Array of Account Ranges","items":{"$ref":"#/components/schemas/account_range_response"},"type":"array"}},"required":["account_ranges"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"account_range_update_request":{"additionalProperties":false,"properties":{"end_date":{"description":"The time when account range becomes inactive","example":"Tue Jan 31 2023 02:54:58 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"is_tokenization_enabled":{"description":"Controls whether account range allows tokenization","example":true,"type":"boolean"},"physical_card_format":{"$ref":"#/components/schemas/physical_card_format"},"start_date":{"description":"The time when account range becomes active","example":"Fri Jul 22 2022 12:41:26 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"type":"object"},"account_relationship_type":{"description":"Relationship type","enum":["ACCOUNT_HOLDER","PRIMARY_ACCOUNT_HOLDER","JOINT_ACCOUNT_HOLDER","AUTHORIZED_SIGNER"],"type":"string"},"account_routing":{"properties":{"ach_routing_number":{"description":"The routing number used for US ACH payments. Only appears if `bank_countries` contains `US`. Value may be masked, in which case only the last four digits are returned.\n","example":"756392185","type":"string"},"bank_countries":{"description":"The countries that this bank operates the account in","items":{"enum":["US","CA"],"type":"string"},"type":"array"},"bank_name":{"description":"The name of the bank managing the account","example":"Chase","type":"string"},"eft_routing_number":{"description":"The routing number used for EFT payments, identifying a Canadian bank, consisting of the institution number and the branch number. Only appears if `bank_countries` contains `CA`. Value may be masked, in which case only the last four digits are returned.\n","example":"02101140","type":"string"},"swift_code":{"description":"The SWIFT code for the bank. Value may be masked, in which case only the last four characters are returned.\n","example":"CHASUS3AXXX","type":"string"},"wire_routing_number":{"description":"The routing number used for domestic wire payments. Only appears if `bank_countries` contains `US`. Value may be masked, in which case only the last four digits are returned.\n","example":"756392185","type":"string"}},"required":["bank_name","bank_countries"],"title":"Routing information for the account","type":"object"},"account_summary":{"properties":{"account_number":{"description":"Account number","type":"string"},"account_status":{"description":"Account Status","type":"string"},"account_type":{"description":"The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed.\n","type":"string"},"balance_ceiling":{"properties":{"balance":{"description":"Maximum balance in the account's currency. Unit in cents.","format":"int64","type":"integer"}},"type":"object"},"balance_floor":{"properties":{"balance":{"description":"Minimum balance in the account's currency. Unit in cents.","format":"int64","type":"integer"}},"type":"object"},"creation_time":{"description":"Account creation time","format":"date-time","type":"string"},"currency":{"description":"Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD","example":"YER","pattern":"^[A-Z]{3}$","type":"string"},"customer_type":{"description":"Customer type","type":"string"},"financial_institution":{"$ref":"#/components/schemas/financial_institution","readOnly":true},"id":{"description":"The unique identifier of the account the statement belongs to","format":"uuid","type":"string"},"last_updated_time":{"description":"Account last modification time","format":"date-time","type":"string"},"nickname":{"description":"User provided account nickname","type":"string"}},"title":"Account Summary","type":"object"},"account_template":{"properties":{"application_type":{"$ref":"#/components/schemas/application_type","type":"string"},"description":{"description":"User provided account template description","type":"string"},"id":{"description":"Generated ID for the template","format":"uuid","readOnly":true,"type":"string"},"is_enabled":{"description":"Whether this template can be used for account creation","type":"boolean"},"name":{"description":"Unique account template name","type":"string"},"template":{"$ref":"#/components/schemas/template_fields"}},"required":["name","is_enabled","template"],"type":"object"},"account_template_response":{"properties":{"application_type":{"$ref":"#/components/schemas/application_type","type":"string"},"description":{"description":"Account template description","type":"string"},"id":{"description":"Generated ID for the template","format":"uuid","type":"string"},"is_enabled":{"description":"Whether this template can be used for account creation","type":"boolean"},"name":{"description":"Unique account template name","type":"string"},"template":{"$ref":"#/components/schemas/template_fields_generic_response"}},"required":["name","is_enabled","template"],"type":"object"},"account_to_account_transfer_request":{"description":"A request to transfer funds from one account to another","properties":{"amount":{"description":"The amount (in cents) to transfer from originating account to receiving account.","format":"int64","minimum":0,"type":"integer"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","example":"USD","type":"string"},"description":{"description":"A description of the transaction","type":"string"},"dest_account_alias":{"description":"An alias representing a GL account to credit. This is an alternative to specifying by account id","example":"ach_suspense","type":"string"},"dest_account_no":{"description":"The account number of the account being credited","type":"string"},"effective_date":{"description":"The date the transaction should be effective","format":"date-time","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"memo":{"description":"A short note to the recipient","type":"string"},"offset_description":{"description":"A description of the offsetting transaction","type":"string"},"posted_date":{"description":"The date the transaction was posted","format":"date-time","type":"string"},"source_account_alias":{"description":"An alias representing a GL account to debit. This is alternative to specifying by account id","example":"ach_suspense","type":"string"},"source_account_no":{"description":"The account number of the account being debited","type":"string"},"subtype":{"description":"The desired transaction subtype to use for this transfer","type":"string"},"type":{"description":"The desired transaction type to use for this transfer","type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"},"uuid":{"description":"The UUID of the transaction","format":"uuid","type":"string"}},"required":["uuid","source_account_no","source_account_alias","dest_account_no","dest_account_alias","type","subtype","amount","currency","effective_date","memo","user_data","external_data"],"title":"Account to Account Transfer Request","type":"object"},"account_type":{"description":"The type of the account. In lead mode, this always takes the value of the template. If not\nspecified in shadow mode, CHECKING will be assumed. Below mentioned are the account types:\n* SAVING: Savings account\n* CHECKING: Checking account\n* LINE_OF_CREDIT: Line of Credit account\n","enum":["SAVING","CHECKING","LINE_OF_CREDIT"],"title":"Account Type","type":"string"},"account_verification":{"description":"Information about the account verification process. If the account has not been verified, this will be null.\n","discriminator":{"mapping":{"FINICITY":"#/components/schemas/finicity_account_verification","MANUAL":"#/components/schemas/manual_account_verification","PLAID":"#/components/schemas/plaid_account_verification"},"propertyName":"vendor"},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/plaid_account_verification"},{"$ref":"#/components/schemas/manual_account_verification"},{"$ref":"#/components/schemas/finicity_account_verification"}],"title":"Information about the account verification process","type":"object"},"accrual_payout_schedule":{"enum":["NONE","MONTHLY"],"type":"string"},"ach_instruction":{"properties":{"request":{"$ref":"#/components/schemas/outgoing_ach_request"},"type":{"enum":["ACH"],"type":"string"}},"required":["type","request"],"type":"object"},"ach_request_hold_data":{"properties":{"amount":{"type":"integer"},"duration":{"example":2,"minimum":0,"type":"integer"}},"required":["amount","duration"],"type":"object"},"add_accounts_request":{"properties":{"account_identifiers":{"$ref":"#/components/schemas/add_accounts_request_account_identifiers"},"account_owner_names":{"description":"The names of the account owners.","items":{"example":"Miss Clark Maggio","minLength":1,"type":"string"},"minItems":1,"type":"array"},"business_id":{"description":"The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` must be specified.\n","example":"fc8d475c-0d6d-4139-8010-93c57ce5eed1","format":"uuid","type":"string"},"customer_id":{"description":"The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` must be specified.\n","example":"91a0ced5-2403-4a98-9b9f-c4577834eac1","format":"uuid","type":"string"},"customer_type":{"$ref":"#/components/schemas/ext_account_customer_type"},"metadata":{"description":"User-supplied metadata","type":"object"},"nickname":{"description":"A user-meaningful name for the account","example":"Money Market Account","minLength":1,"type":"string"},"routing_identifiers":{"$ref":"#/components/schemas/add_accounts_request_routing_identifiers"},"type":{"description":"The type of the account","enum":["CHECKING","SAVINGS"],"type":"string"},"vendor_account_id":{"description":"The ID of the vendor account, will be empty for MANUAL vendor","example":"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo","minLength":1,"type":"string"},"verification":{"$ref":"#/components/schemas/account_verification"}},"required":["type","customer_type","account_owner_names","routing_identifiers","account_identifiers"],"type":"object"},"add_accounts_request_account_identifiers":{"properties":{"number":{"description":"The account number. On write, Synctera will store the entire account number; on read, we only return the last 4 characters.\n","example":"78277121","minLength":1,"type":"string"}},"required":["number"],"title":"Identifiers for the account","type":"object"},"add_accounts_request_routing_identifiers":{"properties":{"ach_routing_number":{"description":"The routing number used for US ACH payments.\n","example":"756392185","minLength":1,"type":"string"},"bank_countries":{"description":"The countries that this bank operates the account in","items":{"enum":["US"],"type":"string"},"minItems":1,"type":"array"},"bank_name":{"description":"The name of the bank managing the account","example":"Chase","minLength":1,"type":"string"},"wire_routing_number":{"description":"The routing number used for US wire payments.\n","example":"915075033","minLength":1,"type":"string"}},"required":["bank_name","bank_countries","ach_routing_number"],"title":"Identifiers for the bank","type":"object"},"add_vendor_account_failure":{"properties":{"reason":{"$ref":"#/components/schemas/add_vendor_accounts_error_reason"},"reason_description":{"description":"A human-readable message describing the reason for the failure.","type":"string"},"vendor_account_id":{"description":"The vendor account ID for the account that failed. For Plaid, this is an `account_id`.\n","example":"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo","type":"string"},"vendor_error_message":{"description":"The display_message returned by the vendor. Only returned if reason is set to `PROVIDER_ERROR`. For Plaid, this is the `display_message`.\n","type":"string"},"vendor_request_id":{"description":"A unique identifier for the request from the vendor, which can be used for troubleshooting. Only returned if reason is set to `PROVIDER_ERROR`.\n","type":"string"}},"required":["vendor_account_id","reason","reason_description"],"type":"object"},"add_vendor_accounts_error_reason":{"description":"A machine-readable code describing the reason for the failure.","enum":["FAILED_VERIFICATION","UNSUPPORTED_ACCOUNT_TYPE","DUPLICATE_ACCOUNT","ACCOUNT_NOT_FOUND","PROVIDER_ERROR"],"type":"string"},"add_vendor_accounts_request":{"properties":{"business_id":{"description":"The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` must be specified.\n","example":"144405a0-1cac-455e-89c9-fd06b97fdbe3","format":"uuid","type":"string"},"customer_id":{"description":"The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` must be specified.\n","example":"6bcc6fab-7bbd-4356-bdfc-3b9b93115a6e","format":"uuid","type":"string"},"customer_type":{"$ref":"#/components/schemas/ext_account_customer_type"},"vendor":{"$ref":"#/components/schemas/external_account_vendor_values"},"vendor_access_token":{"description":"The token provided to link external accounts. For Plaid, this is their `access_token`.\n","example":"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6","minLength":1,"type":"string"},"vendor_account_ids":{"description":"The list of vendor account IDs that the customer chose to link. For Plaid, these are `account_id`s.\n","items":{"description":"The Plaid account_id.","example":"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo","minLength":1,"type":"string"},"minItems":1,"type":"array"},"vendor_customer_id":{"description":"The identifier provided by the vendor for the customer associated with this external account.\n","example":380,"type":"string"},"verify_owner":{"default":false,"description":"If true, Synctera will attempt to verify that the external account owner is the same as the customer by comparing external account data to customer data. At least 2 of the following fields must match: name, phone number, email, address. Verification is disabled by default.\n","type":"boolean"}},"required":["customer_type","vendor"],"type":"object"},"add_vendor_accounts_response":{"properties":{"added_accounts":{"items":{"$ref":"#/components/schemas/external_account","description":"Information about a successfully added external account."},"type":"array"},"deleted_accounts":{"items":{"$ref":"#/components/schemas/external_account","description":"Information about a successfully deleted external account."},"type":"array"},"failed_accounts":{"items":{"$ref":"#/components/schemas/add_vendor_account_failure","description":"Information about an external account that could not be added."},"type":"array"}},"required":["added_accounts","failed_accounts"],"type":"object"},"additional_data":{"description":"Contains additional information about the relationship.","properties":{"title":{"description":"The professional role or position the person holds at the related organization.","enum":["OFFICER","DIRECTOR"],"format":"enum","type":"string"}},"required":["title"],"type":"object"},"additional_owner_data":{"description":"Contains additional information about the relationship.","properties":{"percent_ownership":{"description":"Percentage ownership of the related business.","example":35.75,"exclusiveMinimum":true,"format":"double","maximum":100,"minimum":0,"type":"number"}},"required":["percent_ownership"],"type":"object"},"address":{"properties":{"address_line_1":{"description":"Street address line 1","example":"4992 Curtis Ports","type":"string"},"address_line_2":{"description":"String address line 2","example":"Apt. 877","type":"string"},"city":{"description":"City","example":"East Winstonview","type":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","pattern":"^[A-Z]{2}$","type":"string"},"postal_code":{"description":"Postal code","example":"28620","type":"string"},"state":{"description":"State, region, province, or prefecture","example":"NJ","type":"string"}},"required":["address_line_1","country_code"],"type":"object"},"address1":{"properties":{"address_line_1":{"description":"Street address line 1","example":"0624 Kulas Turnpike","type":"string"},"address_line_2":{"description":"String address line 2","example":"Apt. 024","type":"string"},"city":{"description":"City","example":"Jastfort","type":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"CG","type":"string"},"postal_code":{"description":"Postal code","example":"49633","type":"string"},"state":{"description":"State, region, province, or prefecture","example":"ID","type":"string"}},"required":["address_line_1","city","state","country_code","postal_code"],"type":"object"},"address2":{"properties":{"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"country_code":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"title":"Address","type":"object"},"adhoc_verification_request":{"description":"Basic identifying information about the person being verified.\n","properties":{"payee_id":{"description":"Synctera party (non-customer) who is receiving money from a customer (the payer)","format":"uuid","type":"string"},"payer_id":{"description":"Synctera customer who is sending money to a non-customer (the payee)","format":"uuid","type":"string"}},"required":["payer_id","payee_id"],"type":"object"},"adhoc_verification_response":{"properties":{"id":{"description":"Unique ID for this verification result.","example":"e1f96150-4715-424b-8f8c-ec3188628073","format":"uuid","type":"string"},"matching_watchlists":{"description":"list of watchlists that the subject of the request matched\n","items":{"enum":["US_OFAC"],"type":"string"},"type":"array"},"result":{"$ref":"#/components/schemas/verification_result"},"vendor_info":{"$ref":"#/components/schemas/vendor_info"}},"required":["id","matching_watchlists","result"],"type":"object"},"alias":{"properties":{"account_id":{"description":"Account ID","format":"uuid","type":"string"},"account_number":{"description":"Account number","type":"string"},"alias_info":{"description":"Additional information for the alias","type":"object"},"alias_name":{"description":"Alias name","type":"string"},"alias_source":{"description":"Alias source","type":"string"},"alias_type":{"description":"Alias type","type":"string"},"id":{"description":"Alias ID","format":"uuid","readOnly":true,"type":"string"}},"title":"Account Alias","type":"object"},"alias_list":{"properties":{"aliases":{"description":"Array of account alias","items":{"$ref":"#/components/schemas/alias"},"type":"array"}},"required":["aliases"],"type":"object"},"apple_digital_wallet_provision_request":{"properties":{"certificates":{"description":"Leaf and sub-CA certificates provided by Apple","items":{"description":"Array of Base64 encoded certificates from Apple.","type":"string"},"type":"array"},"device_type":{"$ref":"#/components/schemas/device_type"},"nonce":{"description":"One-time-use nonce provided by Apple for security purposes.","type":"string"},"nonce_signature":{"description":"Apple-provided signature to the nonce.","type":"string"},"provisioning_app_version":{"$ref":"#/components/schemas/provisioning_app_version"}},"required":["device_type","provisioning_app_version","certificates","nonce","nonce_signature"],"type":"object"},"apple_digital_wallet_provision_response":{"properties":{"activation_data":{"type":"string"},"card_id":{"$ref":"#/components/schemas/card_id"},"created_time":{"example":"Wed May 11 2022 11:26:56 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"encrypted_pass_data":{"type":"string"},"ephemeral_public_key":{"type":"string"},"last_modified_time":{"example":"Sat Jul 09 2022 10:39:01 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"type":"object"},"application":{"properties":{"application_details":{"description":"Details about the applicant. The exact schema is to be determined with your bank.","example":{"annual_salary":50000,"fico_score":700},"type":"object"},"customer_id":{"description":"Customer ID for the application","format":"uuid","type":"string"},"status":{"$ref":"#/components/schemas/application_status","default":"APPLICATION_SUBMITTED"},"type":{"$ref":"#/components/schemas/application_type1"}},"required":["customer_id","application_details","type"],"title":"Credit application details","type":"object"},"application_list":{"allOf":[{"properties":{"applications":{"description":"Array of credit applications.","items":{"$ref":"#/components/schemas/application_response"},"type":"array"}},"required":["applications"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"application_list_response":{"allOf":[{"properties":{"external_applications":{"description":"Array of External Applications","items":{"$ref":"#/components/schemas/application_response1"},"type":"array"}},"required":["external_applications"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"application_patch":{"properties":{"application_details":{"description":"Details about the applicant. The exact schema is to be determined with your bank.","example":{"annual_salary":50000,"fico_score":700},"type":"object"},"status":{"$ref":"#/components/schemas/application_status"}},"title":"Credit application details","type":"object"},"application_request":{"properties":{"bank_id":{"description":"Bank ID","type":"integer"},"business_address":{"$ref":"#/components/schemas/address1"},"business_name":{"description":"todo","type":"string"},"business_phone":{"description":"todo","type":"string"},"business_tax_id":{"description":"todo","maxLength":9,"minLength":9,"type":"string"},"business_type":{"description":"todo","enum":["INDIVIDUAL_SOLE_PROPRIETORSHIP","CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","ASSOCIATION_ESTATE_TRUST","TAX_EXEMPT_ORGANIZATION","INTERNATIONAL_ORGANIZATION","GOVERNMENT_AGENCY"],"type":"string"},"dob":{"$ref":"#/components/schemas/external_payment_date"},"doing_business_as":{"description":"todo","type":"string"},"email":{"description":"todo","type":"string"},"enabled":{"description":"To enable or disable aft/oct feature","type":"boolean"},"first_name":{"description":"todo","type":"string"},"incorporation_date":{"$ref":"#/components/schemas/external_payment_date"},"last_name":{"description":"todo","type":"string"},"max_transaction_amount":{"description":"Maximum amount that can be transacted for a single transaction in cents","type":"integer"},"partner_id":{"description":"Partner ID","type":"integer"},"personal_address":{"$ref":"#/components/schemas/address1"},"phone":{"description":"todo","type":"string"},"principal_percentage_ownership":{"description":"todo","type":"string"},"processor":{"$ref":"#/components/schemas/processor"},"tax_id":{"description":"todo","maxLength":9,"minLength":9,"type":"string"},"title":{"description":"todo","type":"string"},"url":{"description":"todo","type":"string"}},"required":["processor","business_name","doing_business_as","business_type","business_tax_id","business_phone","business_address","max_transaction_amount","bank_id","partner_id","enabled"],"type":"object"},"application_response":{"properties":{"application_details":{"description":"Details about the applicant. The exact schema is to be determined with your bank.","example":{"annual_salary":50000,"fico_score":700},"type":"object"},"creation_time":{"description":"Application creation timestamp in RFC3339 format","format":"date-time","readOnly":true,"type":"string"},"customer_id":{"description":"Customer ID for the application","format":"uuid","type":"string"},"id":{"description":"Generated ID for the application","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"Timestamp of the last application modification in RFC3339 format","format":"date-time","readOnly":true,"type":"string"},"status":{"$ref":"#/components/schemas/application_status"},"type":{"$ref":"#/components/schemas/application_type1"}},"required":["customer_id","application_details","type","status","id","creation_time","last_updated_time"],"title":"Credit application details","type":"object"},"application_response1":{"properties":{"created_time":{"example":"2020-01-01T00:00:00.000Z","format":"date-time","type":"string"},"enabled":{"description":"To enable or disable aft/oct feature","type":"boolean"},"external_id":{"description":"The id of the application from processor","type":"string"},"id":{"description":"The id of the application","type":"string"},"last_modified_time":{"example":"2020-01-01T00:00:00.000Z","format":"date-time","type":"string"},"processor":{"$ref":"#/components/schemas/processor"}},"required":["id","created_time","last_modified_time","processor","enabled"],"type":"object"},"application_status":{"description":"Status of the credit application\n","enum":["APPLICATION_SUBMITTED","CREDIT_APPROVED","CREDIT_DENIED","CREDIT_NOT_ACCEPTED_BY_CUSTOMER","CREDIT_ACCEPTED_BY_CUSTOMER"],"title":"Application Status","type":"string","x-enumDescriptions":[{"APPLICATION_SUBMITTED":"Credit application has been submitted"},{"CREDIT_APPROVED":"Credit application has been approved"},{"CREDIT_DENIED":"Credit application has been denied"},{"CREDIT_NOT_ACCEPTED_BY_CUSTOMER":"Credit application has not been accepted by the customer"},{"CREDIT_ACCEPTED_BY_CUSTOMER":"Credit application has been accepted by the customer"}]},"application_type":{"description":"The type of the application.\n* LINE_OF_CREDIT: line of credit application\n* RESTRICTED_ACCOUNT: restricted account application\n","enum":["LINE_OF_CREDIT","RESTRICTED_ACCOUNT"],"title":"Application Type","type":"string"},"application_type1":{"description":"Type of Credit Application","enum":["LINE_OF_CREDIT"],"example":"LINE_OF_CREDIT","title":"Type of Credit Application","type":"string","x-enumDescriptions":[{"LINE_OF_CREDIT":"Line of credit application type"}]},"application_update_request":{"properties":{"enabled":{"description":"To enable or disable aft/oct feature","type":"boolean"},"processor":{"$ref":"#/components/schemas/processor"}},"type":"object"},"auth_request_model":{"properties":{"amount":{"description":"The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"card_acceptor":{"$ref":"#/components/schemas/card_acceptor_model"},"card_id":{"format":"uuid","type":"string"},"card_options":{"$ref":"#/components/schemas/card_options"},"cash_back_amount":{"type":"integer"},"is_pre_auth":{"default":false,"type":"boolean"},"mid":{"maxLength":50,"minLength":1,"type":"string"},"network_fees":{"items":{"$ref":"#/components/schemas/network_fee_model"},"type":"array"},"pin":{"maxLength":50,"minLength":1,"type":"string"},"transaction_options":{"$ref":"#/components/schemas/transaction_options"}},"required":["amount","card_id","mid"],"type":"object"},"authorization_advice_model":{"properties":{"amount":{"description":"The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"network_fees":{"items":{"$ref":"#/components/schemas/network_fee_model"},"type":"array"},"original_transaction_id":{"format":"uuid","type":"string"},"transaction_options":{"$ref":"#/components/schemas/transaction_options"}},"required":["amount","original_transaction_id"],"type":"object"},"balance":{"properties":{"balance":{"description":"balance in ISO 4217 minor currency units. Unit in cents.","example":43,"format":"int64","readOnly":true,"type":"integer"},"type":{"$ref":"#/components/schemas/balance_type"}},"required":["type","balance"],"type":"object"},"balance_ceiling":{"properties":{"balance":{"description":"Maximum balance in the account's currency. Unit in cents.","format":"int64","minimum":0,"type":"integer"},"linked_account_id":{"description":"ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling\n","format":"uuid","type":"string"},"overflow_account_id":{"deprecated":true,"description":"ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling\nThis attribute is a deprecated alias for linked_account_id.\n","format":"uuid","type":"string"}},"required":["balance"],"type":"object"},"balance_floor":{"properties":{"balance":{"description":"Minimum balance in the account's currency. Unit in cents.","format":"int64","type":"integer"},"linked_account_id":{"description":"ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor\n","format":"uuid","type":"string"},"overdraft_account_id":{"deprecated":true,"description":"ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor\nThis attribute is a deprecated alias for linked_account_id.\n","format":"uuid","type":"string"}},"required":["balance"],"type":"object"},"balance_inquiry_request_model":{"properties":{"account_type":{"enum":["checking","savings","credit"],"type":"string"},"card_acceptor":{"$ref":"#/components/schemas/card_acceptor_model"},"card_id":{"format":"uuid","type":"string"},"mid":{"maxLength":50,"minLength":1,"type":"string"},"network_fees":{"items":{"$ref":"#/components/schemas/network_fee_model"},"type":"array"},"pin":{"maxLength":15,"minLength":1,"type":"string"}},"required":["account_type","card_acceptor","card_id","mid"],"type":"object"},"balance_type":{"description":"For `SAVING` and `CHECKING` accounts:\n* `ACCOUNT_BALANCE`: the amount of money in the account. Equal to the sum of credits minus debits for all posted transactions.\n* `AVAILABLE_BALANCE`: the account balance minus any pending debits.\n\nFor `LINE_OF_CREDIT` accounts:\n* `ACCOUNT_BALANCE`: the amount of credit currently in use. Equal to the sum of debits minus credits for all posted transactions.\n* `AVAILABLE_BALANCE`: the amount of credit available. Equal to the credit limit minus `account_balance` minus any pending debits.\n","enum":["ACCOUNT_BALANCE","AVAILABLE_BALANCE"],"type":"string"},"ban_status":{"description":"(alpha) Ban status of the person. One of the following:\n* `ALLOWED` – person is not banned\n* `BANNED` – person is banned\n","enum":["ALLOWED","BANNED"],"example":"ALLOWED","type":"string"},"bank_debit_network_response":{"allOf":[{"$ref":"#/components/schemas/debit_network"},{"properties":{"bank_network_id":{"description":"The ID of the bank network","type":"string"},"bin_id":{"description":"The ID of the bank's bin that uses this debit network","format":"uuid","type":"string"}},"type":"object"}]},"base":{"properties":{"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"ein":{"description":"U.S. Employer Identification Number (EIN) for this business, in the format xx-xxxxxxx.","example":"12-3456789","type":"string"},"email":{"description":"Business's email.","example":"Coty_Nolan@gmail.com","type":"string"},"entity_name":{"description":"Business's legal name.","example":"Apex Corporation","type":"string"},"formation_date":{"description":"Date the business was legally registered in RFC 3339 full-date format (YYYY-MM-DD).","example":"2000-01-01","format":"date","type":"string"},"formation_state":{"description":"U.S. state where the business is legally registered (2-letter abbreviation).","example":"OK","type":"string"},"id":{"description":"Business's unique identifier.","example":"7605b35b-e6dd-48bc-b16c-fc26c3961338","format":"uuid","readOnly":true,"type":"string"},"is_customer":{"$ref":"#/components/schemas/is_customer"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"legal_address":{"$ref":"#/components/schemas/address","description":"Business's legal address."},"metadata":{"$ref":"#/components/schemas/metadata"},"phone_number":{"description":"Business's phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string"},"status":{"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"},"structure":{"description":"Business's legal structure.","enum":["SOLE_PROPRIETORSHIP","PARTNERSHIP","LLC","CORPORATION","S_CORPORATION","NON_PROFIT","OTHER"],"example":"CORPORATION","type":"string"},"trade_names":{"description":"Other names by which this business is known.","example":["Apex","Apex LLC","CorporationID#77231"],"items":{"type":"string"},"type":"array"},"verification_last_run":{"description":"Date and time KYB verification was last run on the business.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"verification_status":{"$ref":"#/components/schemas/verification_status"},"website":{"description":"Business's website.","example":"https://example.com","type":"string"}},"type":"object"},"base_account_verification":{"properties":{"creation_time":{"description":"The time at which verification was first completed.","example":"2022-01-01T00:00:00.000Z","format":"date-time","type":"string"},"last_updated_time":{"description":"The time at which verification was last updated.","example":"2022-01-01T00:00:00.000Z","format":"date-time","type":"string"},"status":{"description":"The status of verification","enum":["VERIFIED","UNVERIFIED"],"type":"string"},"vendor":{"description":"The vendor used for verifying the account","enum":["PLAID","MANUAL","FINICITY"],"type":"string"}},"required":["status","vendor"],"title":"Information about account verification","type":"object"},"base_card":{"allOf":[{"$ref":"#/components/schemas/card_format"},{"properties":{"account_id":{"description":"The ID of the account to which the card will be linked","example":"98d3a7dd-8b7e-4b93-94b0-f5c9bcf88b39","format":"uuid","type":"string"},"bin":{"description":"The bin number","type":"string"},"card_brand":{"$ref":"#/components/schemas/card_brand"},"card_product_id":{"description":"The card product to which the card is attached","example":"f453e97a-83f8-4810-bdbc-8df324fc4241","format":"uuid","type":"string"},"creation_time":{"description":"The timestamp representing when the card issuance request was made","example":"Tue Feb 08 2022 13:13:56 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"customer_id":{"description":"The ID of the customer to whom the card will be issued","example":"a33e874c-4fa5-4c6f-850f-0778ffa097e9","format":"uuid","type":"string"},"emboss_name":{"$ref":"#/components/schemas/emboss_name"},"expiration_month":{"example":"06","readOnly":true,"type":"string"},"expiration_time":{"description":"The timestamp representing when the card would expire at","example":"Sat Mar 05 2022 01:33:52 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"expiration_year":{"example":"25","readOnly":true,"type":"string"},"id":{"description":"Card ID","example":"57f266f7-5661-4e83-8a9a-ac19c76fb82f","format":"uuid","readOnly":true,"type":"string"},"is_pin_set":{"default":false,"description":"indicates whether a pin has been set on the card","example":true,"readOnly":true,"type":"boolean"},"last_four":{"description":"The last 4 digits of the card PAN","example":"1234","readOnly":true,"type":"string"},"last_modified_time":{"description":"The timestamp representing when the card was last modified at","example":"Sun Nov 21 2021 04:23:47 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/card_metadata"},"reissue_reason":{"description":"This is the reason the card needs to be reissued, if any. The reason determines several behaviours:\n  - whether or not the new card will use the same PAN as the original card\n  - the old card will be terminated and if so, when it will be terminated\n\nReason                 | Same PAN | Terminate Old Card\n---------------------- | -------- | ------------------\nEXPIRATION             | yes      | on activation\nLOST                   | no       | immediately\nSTOLEN                 | no       | immediately\nDAMAGED                | yes      | on activation\nVIRTUAL_TO_PHYSICAL(*) | yes      | on activation\nPRODUCT_CHANGE         | yes      | on activation\nNAME_CHANGE(**)        | yes      | on activation\nAPPEARANCE             | yes      | on activation\n\n(*) VIRTUAL_TO_PHYSICAL is deprecated. Please use PRODUCT_CHANGE whenever reissuing from one\ncard product to another, including from a virtual product to a physical product.\n\n(**) NAME_CHANGE is deprecated. Please use APPEARANCE whenever reissuing in order to change the\nappearance of a card, such as the printed name or custom image.\n\nFor all reasons, the new card will use the same PIN as the original card and digital wallet tokens will\nreassigned to the new card\n","enum":["EXPIRATION","LOST","STOLEN","DAMAGED","NAME_CHANGE","VIRTUAL_TO_PHYSICAL","PRODUCT_CHANGE","APPEARANCE"],"type":"string"},"reissued_from_id":{"description":"When reissuing a card, specify the card to be replaced here. When getting a card's details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.\n","example":"6d346154-0b81-493f-87b2-2996bf9a1c0a","format":"uuid","type":"string"},"reissued_to_id":{"description":"If this card was reissued, this ID refers to the card that replaced it.","example":"abfc62db-8ea8-4218-a3fe-d534c34acc09","format":"uuid","readOnly":true,"type":"string"},"type":{"description":"Indicates the type of card to be issued","enum":["DEBIT"],"type":"string"}},"required":["form"],"type":"object"}]},"base_disclosure":{"properties":{"business_id":{"$ref":"#/components/schemas/business_id1"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"disclosure_date":{"description":"Date and time the disclosure was made.","example":"2021-06-14T11:21:17Z","format":"date-time","type":"string"},"event_type":{"description":"Describes how the disclosure was shown and what the user did as a result.\nOne of the following:\n* `DISPLAYED` —\n    The document was made visible to the user,\n    but they did not interact with it.\n* `VIEWED` —\n    The document was made visible to the user,\n    and they interacted enough to see the whole document (e.g. scrolled to the bottom).\n* `ACKNOWLEDGED` —\n    The document was made visible to the user,\n    and they took positive action to confirm that they have read and accepted the document.\n","enum":["DISPLAYED","VIEWED","ACKNOWLEDGED"],"example":"ACKNOWLEDGED","type":"string"},"id":{"$ref":"#/components/schemas/id"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"person_id":{"$ref":"#/components/schemas/person_id"},"type":{"$ref":"#/components/schemas/disclosure_type"},"version":{"$ref":"#/components/schemas/version"}},"type":"object"},"base_master_disclosure":{"properties":{"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"id":{"$ref":"#/components/schemas/id"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"type":{"$ref":"#/components/schemas/disclosure_type"},"version":{"$ref":"#/components/schemas/version"}},"type":"object"},"base_person":{"properties":{"ban_status":{"$ref":"#/components/schemas/ban_status","readOnly":true},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"email":{"description":"Customer's email","example":"Ahmed.Stracke90@gmail.com","type":"string"},"id":{"description":"Customer unique identifier","example":"a0e330bd-fa30-4c1b-882c-abdaac24e7ec","format":"uuid","readOnly":true,"type":"string"},"kyc_exempt":{"description":"Customer's KYC exemption","readOnly":true,"type":"boolean"},"kyc_last_run":{"description":"Date and time KYC was last run on the customer","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"kyc_status":{"$ref":"#/components/schemas/customer_kyc_status","readOnly":true},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"legal_address":{"$ref":"#/components/schemas/address","description":"Customer's legal address"},"metadata":{"description":"User-supplied metadata. Do not use to store PII.","type":"object"},"middle_name":{"description":"Customer's middle name","example":"c","type":"string"},"phone_number":{"description":"Customer's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string"},"related_customers":{"description":"Customer's relationships with other accounts eg. guardian","items":{"$ref":"#/components/schemas/relationship1"},"type":"array"},"shipping_address":{"$ref":"#/components/schemas/address","description":"Customer's shipping address"},"ssn":{"description":"Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Input must match the pattern ^\\d{3}-\\d{2}-\\d{4}$. The response contains the last 4 digits only (e.g. 6789).","example":"651-36-1079","type":"string"},"ssn_source":{"$ref":"#/components/schemas/ssn_source"}},"type":"object"},"base_person1":{"properties":{"ban_status":{"$ref":"#/components/schemas/ban_status","readOnly":true},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"dob":{"description":"Person's date of birth in RFC 3339 full-date format (YYYY-MM-DD).","example":"2000-01-01","format":"date","type":"string"},"email":{"description":"Person's email.","example":"Ethelyn_Bauch@hotmail.com","type":"string"},"first_name":{"description":"Person's first name.","example":"Jedediah","type":"string"},"id":{"description":"Person's unique identifier.","example":"169d1e96-24be-4d56-a3b6-4667da1cd221","format":"uuid","readOnly":true,"type":"string"},"is_customer":{"$ref":"#/components/schemas/is_customer"},"last_name":{"description":"Person's last name.","example":"Purdy","type":"string"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"legal_address":{"$ref":"#/components/schemas/address","description":"Person's legal address."},"metadata":{"$ref":"#/components/schemas/metadata"},"middle_name":{"description":"Person's middle name.","example":"a","type":"string"},"phone_number":{"description":"Person's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string"},"shipping_address":{"$ref":"#/components/schemas/address","description":"Person's shipping address."},"ssn":{"description":"Person's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC. The response contains the last 4 digits only (e.g. 6789).","example":"083-98-3418","type":"string"},"ssn_source":{"$ref":"#/components/schemas/ssn_source"},"status":{"$ref":"#/components/schemas/status1"},"verification_last_run":{"description":"Date and time KYC verification was last run on the person.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"verification_status":{"$ref":"#/components/schemas/verification_status"}},"type":"object"},"base_statement":{"allOf":[{"$ref":"#/components/schemas/statement_summary"},{"properties":{"account_summary":{"$ref":"#/components/schemas/account_summary","readOnly":true},"authorized_signer":{"items":{"$ref":"#/components/schemas/person1"},"readOnly":true,"type":"array"},"disclosure":{"type":"string"},"joint_account_holders":{"items":{"$ref":"#/components/schemas/person1"},"readOnly":true,"type":"array"},"primary_account_holder_business":{"$ref":"#/components/schemas/business1"},"primary_account_holder_personal":{"$ref":"#/components/schemas/person1"},"transactions":{"items":{"$ref":"#/components/schemas/transaction"},"type":"array"}},"type":"object"}],"type":"object"},"base_template_fields":{"properties":{"account_type":{"$ref":"#/components/schemas/account_type","type":"string"},"bank_country":{"description":"Bank country of the account. ISO 3166-1 Alpha-2 or Alpha-3 country code.","example":"US","pattern":"^[A-Z]{2,3}$","type":"string"},"currency":{"description":"Account currency. ISO 4217 alphabetic currency code","example":"USD","pattern":"^[A-Z]{3}$","type":"string"}},"required":["account_type","currency","bank_country"],"type":"object"},"billing_address":{"properties":{"address":{"type":"string"},"compressed_zip":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"zip":{"type":"string"}},"type":"object"},"billing_period":{"description":"The scheme for determining an account's billing period.\n","properties":{"frequency":{"description":"The frequency of billing cycles. Along with the start date, this will determine the start and end of each cycle.\n","enum":["ANNUALLY","MONTHLY","SEMI_MONTHLY","BI_WEEKLY","WEEKLY","DAILY"],"type":"string"},"start_date":{"description":"The first day of the first billing cycle for this account. For a monthly billing cycle, this would determine the day of the month each billing cycle will start on.\n","format":"date-time","type":"string"}},"required":["start_date","frequency"],"type":"object"},"bin":{"properties":{"account_range_length":{"description":"Account range length","type":"integer"},"bank_id":{"description":"The bank ID","type":"integer"},"billing_ica":{"description":"The ICA to which fees will be billed","type":"string"},"bin":{"description":"The bin number","type":"string"},"bin_status":{"$ref":"#/components/schemas/bin_status"},"brand_product_code":{"$ref":"#/components/schemas/brand_product_code"},"card_brand":{"$ref":"#/components/schemas/card_brand"},"card_category":{"$ref":"#/components/schemas/card_category"},"card_product_type":{"$ref":"#/components/schemas/card_product_type"},"country":{"$ref":"#/components/schemas/country_code"},"creation_time":{"description":"The timestamp representing when the bin was created","example":"Thu Sep 16 2021 23:52:38 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"currency":{"$ref":"#/components/schemas/currency_code"},"digital_wallet_active":{"default":false,"description":"Determines if bin supports digital wallet tokenization","example":true,"type":"boolean"},"end_date":{"description":"The time when bin is decommissioned","example":"Sun Nov 27 2022 14:47:06 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"ica_bid":{"description":"ICA/BID","type":"string"},"id":{"description":"Bin ID","example":"73d7087a-6a67-406e-8070-8d53e8134e06","format":"uuid","readOnly":true,"type":"string"},"is_tokenization_enabled":{"default":false,"description":"Controls whether bin allows tokenization","example":false,"type":"boolean"},"last_modified_time":{"description":"The timestamp representing when the bin was last modified","example":"Tue May 10 2022 22:00:58 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"pan_utilization":{"description":"Pan utilization","type":"integer"},"partner_id":{"description":"The partner ID","type":"integer"},"physical_card_format":{"$ref":"#/components/schemas/physical_card_format"},"processor":{"description":"The name of the card processor","type":"string"},"start_date":{"description":"The time when bin goes live","example":"Tue Nov 16 2021 11:24:37 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"required":["bank_id","partner_id","bin","processor","card_brand","card_category","card_product_type","ica_bid","country","currency","account_range_length","billing_ica","brand_product_code","pan_utilization"],"type":"object"},"bin_and_debit_network":{"properties":{"bank_network_id":{"description":"The ID of the bank network","type":"string"},"bin":{"$ref":"#/components/schemas/bin"},"debit_network":{"$ref":"#/components/schemas/debit_network"}},"required":["bin","debit_network","bank_network_id"],"type":"object"},"bin_and_debit_network_list":{"allOf":[{"properties":{"bin_and_debit_networks":{"description":"Array of BINs and debit networks","items":{"$ref":"#/components/schemas/bin_and_debit_network"},"type":"array"}},"required":["bin_and_debit_networks"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"bin_id":{"description":"The unique identifier of a bin","example":"718e95ce-a36c-48b3-857b-1ae68ebb92c1","format":"uuid","type":"string"},"bin_network_mapping":{"properties":{"active":{"description":"indicates whether mapping is active","type":"boolean"},"bank_network_id":{"description":"ID debit network uses to identify a bank","type":"string"},"bin_id":{"description":"The ID of the bank's BIN that uses this debit network","format":"uuid","type":"string"},"creation_time":{"description":"The timestamp representing when BIN network mapping was created","example":"Mon Jul 04 2022 05:18:48 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"end_date":{"description":"The time when mapping becomes inactive","example":"Sun Jul 24 2022 05:41:16 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"last_modified_time":{"description":"The timestamp representing when the BIN network mapping was last modified","example":"Mon Mar 21 2022 12:46:48 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"network_id":{"description":"The ID of the debit_network associated with the BIN of the bank","format":"uuid","type":"string"},"start_date":{"description":"The time when mapping becomes active","example":"Tue Jun 07 2022 12:40:30 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"required":["bin_id","network_id","active","bank_network_id"],"type":"object"},"bin_network_mapping_response":{"allOf":[{"$ref":"#/components/schemas/bin_network_mapping"}],"required":["bin_id","network_id","active","bank_network_id","start_date","end_date","creation_time","last_modified_time"]},"bin_response":{"allOf":[{"$ref":"#/components/schemas/bin"}],"required":["id","bank_id","partner_id","bin","processor","card_brand","card_category","card_product_type","is_tokenization_enabled","ica_bid","country","currency","bin_status","account_range_length","billing_ica","brand_product_code","creation_time","last_modified_time"]},"bin_response_list":{"allOf":[{"properties":{"bins":{"description":"Array of Bins","items":{"$ref":"#/components/schemas/bin_response"},"type":"array"}},"required":["bins"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"bin_status":{"description":"Bin status","enum":["ACTIVE","INACTIVE"],"type":"string"},"bin_update_request":{"additionalProperties":false,"properties":{"bin_status":{"$ref":"#/components/schemas/bin_status"},"card_brand":{"$ref":"#/components/schemas/card_brand"},"card_category":{"$ref":"#/components/schemas/card_category"},"card_product_type":{"$ref":"#/components/schemas/card_product_type"},"end_date":{"description":"The time when bin is decommissioned","example":"Sun Jan 08 2023 07:10:34 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"is_tokenization_enabled":{"description":"Controls whether bin allows tokenization","example":true,"type":"boolean"},"physical_card_format":{"$ref":"#/components/schemas/physical_card_format"},"start_date":{"description":"The time when bin goes live","example":"Sun Nov 21 2021 08:38:38 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"type":"object"},"brand_product_code":{"description":"The Mastercard or Visa Product Code - 3 alpha-numeric characters","maxLength":3,"minLength":3,"type":"string"},"business":{"allOf":[{"required":["status","is_customer"]},{"$ref":"#/components/schemas/base"}],"description":"Represents a business customer.","type":"object"},"business_business_owner_relationship":{"allOf":[{"required":["from_business_id","to_business_id","additional_data"]},{"$ref":"#/components/schemas/patch_business_business_owner_relationship"}],"description":"Denotes the relationship between specified businesses.","type":"object"},"business_id":{"description":"The unique identifier of a business","example":"4d742b70-9176-4f4b-bcbb-b42fe29b106d","format":"uuid","type":"string"},"business_id1":{"description":"Unique ID for the business. Exactly one of `business_id` or `person_id` must be set.\n","example":"082018a9-6517-440c-9c01-a01e27457d1b","format":"uuid","type":"string"},"business_id2":{"description":"Unique ID for the business. Exactly one of `business_id` or `person_id` must be set.\n","example":"d4f6d078-ccf9-42c1-a001-df2c96783294","format":"uuid","type":"string"},"business_id3":{"description":"Unique ID for the business. Exactly one of `business_id` or `person_id` must be set.\n","example":"6042d105-837c-4d02-99e1-59b9c18f2edf","format":"uuid","type":"string"},"business_id4":{"description":"Unique ID for the business. Exactly one of `business_id` or `person_id` must be set.\n","example":"2c334624-265b-4ac9-9a30-0a1d45ea4bd0","format":"uuid","type":"string"},"business_id5":{"description":"Unique ID for the business. Exactly one of `business_id` or `person_id` must be set.\n","example":"d6bca903-7768-436b-af68-6b46f59d6569","format":"uuid","type":"string"},"business_list":{"allOf":[{"properties":{"businesses":{"description":"Array of businesses.","items":{"$ref":"#/components/schemas/business"},"type":"array"}},"required":["businesses"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"business1":{"properties":{"creation_time":{"format":"date-time","type":"string"},"ein":{"type":"string"},"email":{"type":"string"},"entity_name":{"type":"string"},"formation_date":{"format":"date","type":"string"},"formation_state":{"type":"string"},"id":{"format":"uuid","type":"string"},"last_updated_time":{"format":"date-time","type":"string"},"phone_number":{"type":"string"},"status":{"type":"string"},"structure":{"type":"string"},"trade_names":{"items":{"type":"string"},"type":"array"},"verification_last_run":{"format":"date-time","type":"string"},"verification_status":{"type":"string"}},"title":"Business","type":"object"},"calculation_method":{"enum":["COMPOUNDED_MONTHLY","COMPOUNDED_DAILY"],"type":"string"},"card_acceptor_model":{"example":{"address":"address","city":"city","country":"country","ecommerce_security_level_indicator":"ecommerce_security_level_indicator","mcc":"mcc","name":"name","partial_approval_capable":false,"state":"state","zip":"zip"},"properties":{"address":{"maxLength":255,"minLength":0,"type":"string"},"city":{"maxLength":40,"minLength":0,"type":"string"},"country":{"type":"string"},"ecommerce_security_level_indicator":{"type":"string"},"mcc":{"maxLength":5,"minLength":0,"type":"string"},"name":{"maxLength":50,"minLength":0,"type":"string"},"partial_approval_capable":{"default":false,"type":"boolean"},"state":{"type":"string"},"zip":{"maxLength":10,"minLength":0,"type":"string"}},"type":"object"},"card_activation_request":{"properties":{"activation_code":{"description":"An activation code provided with the card required to prove possession of the card","type":"string"},"customer_id":{"description":"The ID of the customer for which card is being activated","example":"1acf447c-544b-41b4-94f9-bd96b03cc48e","format":"uuid","type":"string"}},"required":["activation_code","customer_id"],"type":"object"},"card_brand":{"description":"The brand of a card product","enum":["MASTERCARD","VISA"],"type":"string"},"card_category":{"description":"The category of the card","enum":["CONSUMER","COMMERCIAL"],"type":"string"},"card_change":{"description":"Card change details","properties":{"change_type":{"$ref":"#/components/schemas/change_type"},"channel":{"$ref":"#/components/schemas/change_channel"},"id":{"description":"Unique token","example":"19d19b55-c8fa-4a78-ae1c-98d37798bec3","format":"uuid","readOnly":true,"type":"string"},"memo":{"$ref":"#/components/schemas/card_status_reason_memo"},"reason":{"$ref":"#/components/schemas/card_status_reason_code"},"state":{"$ref":"#/components/schemas/card_change_state","description":"Updated card state"},"updated_at":{"description":"Date of change","example":"Fri Jul 22 2022 03:09:02 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"updated_by":{"description":"ID of user who initiated the change, if done via Synctera Admin System","type":"string"}},"required":["id","change_type","state","channel","updated_at","updated_by"],"type":"object"},"card_change_state":{"oneOf":[{"$ref":"#/components/schemas/card_fulfillment_status"},{"$ref":"#/components/schemas/card_status"},{"$ref":"#/components/schemas/card_pin_status"}]},"card_changes_list":{"allOf":[{"properties":{"changes":{"description":"List of changes in descending chronological order","items":{"$ref":"#/components/schemas/card_change"},"type":"array"}},"required":["changes"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"card_edit_request":{"properties":{"card_status":{"$ref":"#/components/schemas/card_status_request"},"customer_id":{"description":"The ID of the customer to whom the card will be issued","example":"d76464e0-d13c-4bf9-910f-f7992dc86c88","format":"uuid","type":"string"},"emboss_name":{"$ref":"#/components/schemas/emboss_name"},"memo":{"$ref":"#/components/schemas/card_status_reason_memo"},"metadata":{"$ref":"#/components/schemas/card_metadata"},"reason":{"$ref":"#/components/schemas/card_status_reason_code"}},"type":"object"},"card_format":{"properties":{"form":{"description":"PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string"}},"required":["form"],"type":"object"},"card_fulfillment_status":{"description":"The status indicating the state of the card issuance","enum":["ISSUED","REISSUED","ORDERED","REJECTED","REORDERED","SHIPPED","DIGITALLY_PRESENTED"],"type":"string"},"card_id":{"description":"The unique identifier of a card","example":"a1c5f67b-5ebd-4683-b202-c7ae80c87bb7","format":"uuid","type":"string"},"card_image_details":{"properties":{"card_product_id":{"$ref":"#/components/schemas/card_product_id"},"customer_id":{"$ref":"#/components/schemas/customer_id1"},"id":{"$ref":"#/components/schemas/card_image_id"},"rejection_memo":{"type":"string"},"rejection_reason":{"$ref":"#/components/schemas/card_image_rejection_reason"},"status":{"$ref":"#/components/schemas/card_image_status"}},"required":["id","status","customer_id","card_product_id"]},"card_image_details_list":{"allOf":[{"properties":{"images":{"description":"Array of image details","items":{"$ref":"#/components/schemas/card_image_details"},"type":"array"}},"required":["images"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"card_image_id":{"description":"The unique identifier of a card image","example":"7b12abf1-bc0a-4837-886d-c37c86ac8950","format":"uuid","type":"string"},"card_image_mode":{"description":"The image mode of a card product. If the card product supports custom card images, this value determines how the images will be handled during card issuance. REQUIRED means that cards issued with this card product must have the ID of an image that has been uploaded. Note that the image does not necessarily have to have been approved prior to the issuance request. This mode is currently disabled. REQUIRED_APPROVED_FIRST means that cards issued with this card product must have the ID of an image that has been uploaded and approved.\n","enum":["REQUIRED","REQUIRED_APPROVED_FIRST"],"type":"string"},"card_image_rejection_reason":{"description":"The category of reason that a card image was rejected","enum":["COPYRIGHT","TRADEMARK","BRANDED","PROMOTIONAL","INAPPROPRIATE","OTHER"],"type":"string"},"card_image_status":{"description":"The status of a custom card image","enum":["NOT_UPLOADED","UNREVIEWED","APPROVED","REJECTED"],"type":"string"},"card_issuance_request":{"discriminator":{"mapping":{"PHYSICAL":"#/components/schemas/physical_card_issuance_request","VIRTUAL":"#/components/schemas/virtual_card_issuance_request"},"propertyName":"form"},"oneOf":[{"$ref":"#/components/schemas/physical_card_issuance_request"},{"$ref":"#/components/schemas/virtual_card_issuance_request"}],"type":"object"},"card_list_response":{"allOf":[{"properties":{"cards":{"description":"Array of Cards","items":{"$ref":"#/components/schemas/card_response"},"type":"array"}},"required":["cards"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"card_metadata":{"additionalProperties":{"type":"string"},"description":"Additional data to include in the request structured as key-value pairs","type":"object"},"card_options":{"properties":{"billing_address":{"$ref":"#/components/schemas/billing_address"},"card_present":{"default":false,"type":"boolean"},"cvv":{"maxLength":3,"minLength":0,"type":"string"},"expiration":{"maxLength":4,"minLength":4,"type":"string"}},"type":"object"},"card_pin":{"properties":{"pin":{"description":"The new PIN","type":"string"}},"type":"object"},"card_pin_status":{"description":"The status of the card PIN","enum":["SET","CHANGED"],"readOnly":true,"type":"string"},"card_product":{"allOf":[{"$ref":"#/components/schemas/card_format"},{"properties":{"active":{"description":"Indicates whether the Card Product is active","type":"boolean"},"card_program_id":{"description":"Card Program ID","example":"38801923-080c-42b2-912b-db04ed7f466b","format":"uuid","type":"string"},"color":{"description":"Color code for dynamic card elements such as PAN and card holder name","pattern":"^[0-9A-F]{6}$","type":"string"},"creation_time":{"description":"The timestamp representing when the Card Product was created","example":"Tue Jun 28 2022 15:59:07 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"digital_wallet_tokenization":{"$ref":"#/components/schemas/digital_wallet_tokenization"},"end_date":{"description":"The time when the Card Product is decommissioned","example":"Fri Dec 30 2022 09:48:40 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"id":{"description":"Card Product ID","example":"1a7c4037-dd90-4fab-841b-fbd37f0045ed","format":"uuid","readOnly":true,"type":"string"},"image":{"description":"Indicates whether or not there is an overlay image of the card product available","type":"boolean"},"image_mode":{"$ref":"#/components/schemas/card_image_mode"},"last_modified_time":{"description":"The timestamp representing when the Card Product was last modified","example":"Thu Oct 07 2021 14:55:56 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The name of the Card Product","maxLength":40,"minLength":1,"type":"string"},"orientation":{"description":"Card orientation","enum":["HORIZONTAL","VERTICAL"],"type":"string"},"package_id":{"description":"Card fulfillment provider’s package ID","maxLength":50,"minLength":1,"type":"string"},"physical_card_format":{"$ref":"#/components/schemas/physical_card_format"},"return_address":{"$ref":"#/components/schemas/shipping"},"start_date":{"description":"The time when the Card Product goes live","example":"Mon Apr 25 2022 17:32:31 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"txn_enhancer":{"$ref":"#/components/schemas/txn_enhancer"}},"required":["name","card_program_id","active","start_date"],"type":"object"}],"description":"Card Product"},"card_product_id":{"description":"The unique identifier of a cards product","example":"d6180286-ae04-4bdb-ac62-bce0b4b06f91","format":"uuid","type":"string"},"card_product_internal":{"allOf":[{"$ref":"#/components/schemas/card_product"},{"properties":{"account_range_id":{"description":"Account Range ID","example":"3b366454-0b36-4024-a68a-6a0563fc9677","format":"uuid","type":"string"},"auto_allocate_range":{"description":"Identifies whether a new account range will be automatically allocated","type":"boolean"},"bank_id":{"description":"Bank ID","type":"integer"},"bin_id":{"description":"BIN ID","example":"59bf3b88-d4b7-4bf2-a43a-8e43194651bf","format":"uuid","type":"string"},"funding_source_id":{"description":"Funding Source ID","example":"e06f43f7-3d08-4b92-acaf-cd233ce7cb59","format":"uuid","type":"string"},"partner_id":{"description":"Partner ID","type":"integer"}},"required":["bank_id","partner_id","funding_source_id","bin_id","account_range_id","auto_allocate_range"],"type":"object"}],"description":"Card Product Internal"},"card_product_list_response":{"allOf":[{"properties":{"card_products":{"description":"Array of Card Products","items":{"$ref":"#/components/schemas/card_product_response"},"type":"array"}},"required":["card_products"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"card_product_response":{"allOf":[{"$ref":"#/components/schemas/card_product"}],"required":["id","name","card_program_id","active","form","start_date","digital_wallet_tokenization","end_date","creation_time","last_modified_time"]},"card_product_type":{"description":"The type of the card product","enum":["DEBIT","CREDIT","PREPAID"],"type":"string"},"card_product_update_request":{"additionalProperties":false,"properties":{"digital_wallet_tokenization":{"$ref":"#/components/schemas/digital_wallet_tokenization"}},"type":"object"},"card_program":{"properties":{"active":{"description":"indicates whether program is active","type":"boolean"},"bank_id":{"description":"The ID of the bank partner works with within this program","type":"integer"},"card_brand":{"$ref":"#/components/schemas/card_brand"},"card_category":{"$ref":"#/components/schemas/card_category"},"card_product_type":{"$ref":"#/components/schemas/card_product_type"},"creation_time":{"description":"The timestamp representing when the program was created","example":"Wed Feb 09 2022 14:02:52 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"end_date":{"description":"The time when program became inactive","example":"Tue Dec 20 2022 13:08:12 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"id":{"description":"Program ID","example":"37a054b8-fbdb-44c6-ae20-091f94ada475","format":"uuid","readOnly":true,"type":"string"},"last_modified_time":{"description":"The timestamp representing when the program was last modified","example":"Thu Mar 24 2022 05:09:53 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"Program name","type":"string"},"partner_id":{"description":"The ID of the partner program belongs to","type":"integer"},"start_date":{"description":"The time when program becomes active","example":"Mon Aug 08 2022 16:52:42 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"required":["name","bank_id","partner_id","card_brand","card_category","card_product_type"],"type":"object"},"card_program_id":{"description":"The unique identifier of a cards program","example":"d038350d-a45f-42f9-8ecd-dd130637140b","format":"uuid","type":"string"},"card_program_response":{"allOf":[{"$ref":"#/components/schemas/card_program"}],"required":["id","name","bank_id","partner_id","card_brand","card_category","card_product_type","active","start_date","end_date","creation_time","last_modified_time"]},"card_program_response_list":{"allOf":[{"properties":{"programs":{"description":"Array of Card Programs","items":{"$ref":"#/components/schemas/card_program_response"},"type":"array"}},"required":["programs"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"card_program_update_request":{"additionalProperties":false,"properties":{"card_brand":{"$ref":"#/components/schemas/card_brand"},"card_category":{"$ref":"#/components/schemas/card_category"},"card_product_type":{"$ref":"#/components/schemas/card_product_type"},"end_date":{"description":"The time when program became inactive","example":"Wed Aug 16 2023 04:51:41 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"name":{"description":"Program name","type":"string"},"start_date":{"description":"The time when program becomes active","example":"Wed Feb 09 2022 09:27:52 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"type":"object"},"card_response":{"discriminator":{"mapping":{"PHYSICAL":"#/components/schemas/physical_card_response","VIRTUAL":"#/components/schemas/virtual_card_response"},"propertyName":"form"},"oneOf":[{"$ref":"#/components/schemas/physical_card_response"},{"$ref":"#/components/schemas/virtual_card_response"}]},"card_status":{"description":"The status indicating the card lifecycle state","enum":["ACTIVE","UNACTIVATED","SUSPENDED","TERMINATED","IMAGE_PENDING","IMAGE_REJECTED"],"type":"string"},"card_status_object":{"description":"The status of the card","properties":{"card_status":{"$ref":"#/components/schemas/card_status"},"memo":{"$ref":"#/components/schemas/card_status_reason_memo"},"status_reason":{"$ref":"#/components/schemas/card_status_reason_code"}},"required":["card_status"],"title":"Status","type":"object"},"card_status_reason_code":{"description":"The reason for the card status\n\nCode | Description\n--- | ---\nNEW | Card activated\nREQ | Requested by you\nINA | Dormant\nUNK | Invalid shipping address\nNEG | Negative account balance\nREV | Account under review\nSUS | Suspicious activity\nOUT | Activity outside program parameters\nFRD | Confirmed fraud\nMAT | Matched with an OFAC list\nLOS | Card reported lost\nCLO | Card was cloned\nCOM | Account or card was compromised\nTMP | Awaiting customer confirmation\nPRC | Initiated by Processor\nISS | Initiated by Issuer\nEXP | Card expired\nKYC | Failed KYC\nINF | Information was validated\nACT | Account activity was validated\nAUX | Initiated by a third party\nPIN | PIN try limit reached\nSTO | Card reported stolen\nADD | Address issue\nNAM | Name issue\nSSN | SSN issue\nDOB | DOB issue\nEML | Email issue\nPHO | Phone issue\nFUL | Account/fulfillment mismatch\nOTH | Other\n","enum":["NEW","REQ","INA","UNK","NEG","REV","SUS","OUT","FRD","MAT","LOS","CLO","COM","TMP","PRC","ISS","EXP","KYC","INF","ACT","AUX","PIN","STO","ADD","NAM","SSN","DOB","EML","PHO","FUL","OTH"],"type":"string"},"card_status_reason_memo":{"description":"Additional details about the reason for the status change","maxLength":255,"type":"string"},"card_status_request":{"description":"The status indicating the card lifecycle state","enum":["ACTIVE","SUSPENDED","TERMINATED"],"type":"string"},"card_widget_url_response":{"description":"A URL for activate card and set pin widgets","properties":{"url":{"format":"uri","type":"string"}},"type":"object"},"change_channel":{"description":"How the change was submitted","enum":["API","ADMIN","SYSTEM","FRAUD"],"type":"string"},"change_type":{"description":"The category of card change","enum":["STATUS","FULFILLMENT","PIN"],"type":"string"},"clearing_model":{"example":{"amount":80,"card_acceptor":{"address":"address","city":"city","country":"country","ecommerce_security_level_indicator":"ecommerce_security_level_indicator","mcc":"mcc","name":"name","partial_approval_capable":false,"state":"state","zip":"zip"},"force_post":false,"is_refund":false,"mid":"mid","network_fees":[{"amount":123,"credit_debit":"C","type":"ISSUER_FEE"},{"amount":123,"credit_debit":"C","type":"ISSUER_FEE"}],"original_transaction_id":"original_transaction_id"},"properties":{"amount":{"description":"The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"card_acceptor":{"$ref":"#/components/schemas/card_acceptor_model"},"force_post":{"default":false,"type":"boolean"},"is_refund":{"default":false,"type":"boolean"},"mid":{"maxLength":50,"minLength":1,"type":"string"},"network_fees":{"items":{"$ref":"#/components/schemas/network_fee_model"},"type":"array"},"original_transaction_id":{"format":"uuid","type":"string"}},"required":["amount","original_transaction_id"],"type":"object"},"client_token":{"description":"A short-lived, one-time token used for accessing client PINs/PANs","properties":{"client_token":{"example":"4899e49c-206e-40c8-ab01-c28a8ca7ccc8","type":"string"}},"title":"Client Token","type":"object"},"contest_ach":{"description":"Contested return","properties":{"type":{"enum":["contested_misrouted","contested_untimely","contested_timely_original","contested_corrected","contested_not_duplicate","contested_no_errors","contested_non_acceptance"],"type":"string"}},"required":["type"],"type":"object"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"CO","maxLength":2,"minLength":2,"type":"string"},"create_card_image_request":{"properties":{"card_product_id":{"$ref":"#/components/schemas/card_product_id"},"customer_id":{"$ref":"#/components/schemas/customer_id1"}},"required":["customer_id","card_product_id"],"type":"object"},"create_gateway_request":{"properties":{"active":{"default":true,"description":"Current status of the Authorization gateway","type":"boolean"},"card_products":{"description":"List of Card Product unique identifiers that will utilize the Gateway","items":{"example":"9faacdc6-bd75-4c79-b39f-898a95a21cac","format":"uuid","type":"string"},"type":"array"},"custom_headers":{"$ref":"#/components/schemas/gateway_custom_headers"},"url":{"description":"URL of the Authorization gateway","format":"uri","maxLength":1000,"type":"string"}},"required":["url","card_products"],"type":"object"},"create_webhook_request":{"allOf":[{"$ref":"#/components/schemas/webhook_request"},{"required":["name","events","config"],"type":"object"}]},"currency_code":{"description":"ISO 4217  Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string"},"custom_headers":{"properties":{"my_header_name_1":{"type":"string"},"my_header_name_2":{"type":"string"},"my_header_name_3":{"type":"string"}},"type":"object"},"customer":{"allOf":[{"properties":{"dob":{"description":"Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD)","example":"2000-01-01","format":"date","type":"string"},"first_name":{"description":"Customer's first name","example":"Baron","type":"string"},"last_name":{"description":"Customer's last name","example":"Rau","type":"string"},"status":{"description":"Customer's status","enum":["ACTIVE","ESCHEAT","DECEASED","DENIED","DORMANT","FROZEN","INACTIVE","PROSPECT","SANCTION"],"type":"string"}},"required":["status"]},{"$ref":"#/components/schemas/base_person"}],"description":"Details of a customer","title":"Customer","type":"object"},"customer_alias":{"description":"Represents a customer's alias","properties":{"alias_info":{"type":"object"},"alias_name":{"type":"string"},"alias_source":{"type":"string"},"alias_type":{"type":"string"},"customer_alias_id":{"format":"uuid","type":"string"},"customer_id":{"format":"uuid","type":"string"}},"title":"Customer Alias","type":"object"},"customer_alias_list":{"allOf":[{"properties":{"customer_alias":{"description":"Array of customer alias","items":{"$ref":"#/components/schemas/customer_alias"},"type":"array"}},"required":["customer_alias"],"type":"object"}]},"customer_id":{"example":"4605deb4-3f8d-4566-9bf1-0dc558b63258","format":"uuid","type":"string"},"customer_id1":{"description":"The unique identifier of a customer","example":"8da2b02b-81f2-41f3-a32e-041eb8ccd825","format":"uuid","type":"string"},"customer_in_body":{"discriminator":{"mapping":{"ACTIVE":"#/components/schemas/customer","DECEASED":"#/components/schemas/customer","DENIED":"#/components/schemas/customer","DORMANT":"#/components/schemas/customer","ESCHEAT":"#/components/schemas/customer","FROZEN":"#/components/schemas/customer","INACTIVE":"#/components/schemas/customer","PROSPECT":"#/components/schemas/prospect","SANCTION":"#/components/schemas/customer"},"propertyName":"status"},"oneOf":[{"$ref":"#/components/schemas/customer"},{"$ref":"#/components/schemas/prospect"}],"type":"object"},"customer_kyc_status":{"description":"Customer's KYC status","enum":["UNVERIFIED","REVIEW","PROVIDER_FAILURE","ACCEPTED","REJECTED","PROVISIONAL"],"type":"string"},"customer_list":{"allOf":[{"properties":{"customers":{"description":"Array of Customers","items":{"$ref":"#/components/schemas/customer_in_body"},"type":"array"}},"required":["customers"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"customer_type":{"description":"Customer type","enum":["BUSINESS","PERSONAL"],"readOnly":true,"title":"Customer Type","type":"string"},"customer_verification":{"example":{"customer_consent":true,"customer_ip_address":"66.152.213.183"},"properties":{"customer_consent":{"description":"Whether this customer has consented to a KYC check.\n","type":"boolean"},"customer_ip_address":{"description":"IP address of the customer being verified.","example":"75.216.112.104","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"},"document_id":{"description":"The ID of the uploaded government-issued identification document provided by the Socure SDK.\n","example":"1ab2c3de-fg45-6789-a01b-23c45678defg","type":"string"},"verification_type":{"description":"List of possible checks to run on a customer. This is a legacy field that is now ignored.\n","items":{"$ref":"#/components/schemas/verification_type"},"type":"array"}},"required":["customer_consent"],"title":"PersonVerification","type":"object"},"customer_verification_result":{"description":"Verification result","properties":{"id":{"description":"Unique ID for this verification result.","example":"54cb1031-4a63-4dee-b6f7-458f267d4676","format":"uuid","readOnly":true,"type":"string"},"issues":{"deprecated":true,"description":"List of potential problems found. These are subject to change.\n","items":{"example":"R186: Global Watchlist sources selected are correlated with the input identifiers","type":"string"},"readOnly":true,"type":"array"},"raw_response":{"$ref":"#/components/schemas/raw_response"},"result":{"description":"The determination of this verification.","enum":["ACCEPTED","REJECTED","REVIEW","PROVIDER_FAILURE","PROVISIONAL"],"example":"ACCEPTED","type":"string"},"vendor_info":{"$ref":"#/components/schemas/verification_vendor_info"},"verification_time":{"description":"The date and time the verification was completed.","format":"date-time","type":"string"},"verification_type":{"$ref":"#/components/schemas/verification_type"}},"required":["verification_type","result","verification_time"],"title":"CustomerVerificationResult","type":"object"},"customer_verification_result_list":{"allOf":[{"properties":{"verifications":{"description":"Array of verification results.","items":{"$ref":"#/components/schemas/customer_verification_result"},"type":"array"}},"required":["verifications"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"customer_verify_response":{"allOf":[{"properties":{"kyc_status":{"$ref":"#/components/schemas/customer_kyc_status"},"verifications":{"description":"Array of verification results.","items":{"$ref":"#/components/schemas/customer_verification_result"},"type":"array"}},"required":["kyc_status","verifications"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"dc_sign":{"description":"The `dc_sign` represents the direction money was moved.","enum":["debit","credit"],"type":"string"},"debit_network":{"properties":{"active":{"description":"indicates whether debit network is active","type":"boolean"},"creation_time":{"description":"The timestamp representing when the debit network was created","example":"Sat Dec 25 2021 20:56:19 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"end_date":{"description":"The time when debit network became inactive","example":"Thu Jul 06 2023 08:14:39 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"id":{"description":"Debit Network ID","example":"8921a7ec-ed00-45c7-8cbe-27ff6a0662d4","format":"uuid","readOnly":true,"type":"string"},"last_modified_time":{"description":"The timestamp representing when the debit network was last modified","example":"Wed Sep 29 2021 23:47:36 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The name describing the debit network","type":"string"},"start_date":{"description":"The time when debit network goes live","example":"Wed Sep 22 2021 18:46:56 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"}},"type":"object"},"debit_network_create_request":{"allOf":[{"$ref":"#/components/schemas/debit_network"}],"required":["name"]},"debit_network_id":{"description":"The unique identifier of a debit network","example":"386adb92-ccd0-4ae8-ab82-c62702b9c6ea","format":"uuid","type":"string"},"debit_network_response":{"allOf":[{"$ref":"#/components/schemas/debit_network"}],"required":["id","name","active","creation_time","last_modified_time"]},"debit_network_response_list":{"allOf":[{"properties":{"debit_networks":{"description":"Array of debit networks","items":{"$ref":"#/components/schemas/debit_network_response"},"type":"array"}},"required":["debit_networks"],"type":"object"}]},"delete_response":{"description":"Deleted object information","properties":{"id":{"description":"Object ID","format":"uuid","type":"string"},"resource":{"description":"The resource name","type":"string"}},"title":"Deleted Object","type":"object"},"deposit":{"description":"Deposit using remote deposit capture","properties":{"account_id":{"description":"The ID of the account","example":"ab144f71-3708-4625-8df3-d9307804475e","format":"uuid","type":"string"},"back_image_id":{"description":"ID of the uploaded image of the back of the check","example":"a745e775-9d35-46a5-812d-4a7663178a3b","format":"uuid","type":"string"},"business_id":{"$ref":"#/components/schemas/business_id4"},"check_amount":{"description":"Amount on check in ISO 4217 minor currency units","example":8032,"minimum":1,"type":"integer"},"creation_time":{"example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"date_captured":{"description":"Date the deposit was captured, in RFC 3339 format","example":"2022-01-02T03:04:05.678Z","format":"date-time","readOnly":true,"type":"string"},"date_processed":{"description":"Date the deposit was processed, in RFC 3339 format","example":"2022-01-02T03:04:05.678Z","format":"date-time","readOnly":true,"type":"string"},"deposit_amount":{"description":"Amount deposited in ISO 4217 minor currency units","example":6207,"readOnly":true,"type":"integer"},"deposit_currency":{"description":"ISO 4217 currency code for the deposit amount","example":"USD","type":"string"},"front_image_id":{"description":"ID of the uploaded image of the front of the check","example":"a6be36a2-1211-4c7f-b38e-14923e009262","format":"uuid","type":"string"},"id":{"description":"Remote Check Deposit ID","example":"69170eba-daa5-4c06-9a6d-abc1d4733f67","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"person_id":{"$ref":"#/components/schemas/person_id"},"status":{"description":"The status of the deposit","enum":["SUBMITTED","PENDING","FAILED","REJECTED"],"readOnly":true,"type":"string"},"transaction_id":{"description":"The ID of the transaction associated with this deposit","example":"261343ed-2752-4e07-b14f-5cafcd38361c","format":"uuid","readOnly":true,"type":"string"},"vendor_info":{"$ref":"#/components/schemas/vendor_info1"}},"required":["id","account_id","transaction_id","check_amount","deposit_currency","status","deposit_amount","date_processed","date_captured","front_image_id","back_image_id","vendor_info"],"title":"Remote Check Deposit","type":"object"},"deposit_feedback":{"description":"Approve or reject deposit transactions","properties":{"feedback":{"description":"The value of the feedback for the deposit transaction","enum":["APPROVE","REJECT"],"type":"string"}},"title":"Remote Check Deposit feedback","type":"object"},"deposit_list":{"allOf":[{"properties":{"deposits":{"description":"Array of  Remote Check Deposits","items":{"$ref":"#/components/schemas/deposit"},"type":"array"}},"required":["deposits"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"detail":{"description":"An object containing information about an individual check performed.","properties":{"description":{"description":"Human-readable description explaining the individual check.","example":"Email address is correlated with the individual's name","type":"string"},"label":{"description":"Human-readable grouping describing the aspect of the customer's identity examined by this check.","example":"Email","type":"string"},"result":{"description":"The result of the individual check. One of the following:\n* `PASS` – the check passed contributing to a positive outcome (or accepted verification result).\n* `WARN` – the results of the check were inconclusive and might require review.\n* `FAIL` – the check failed and might result in a failing outcome (or rejected verification_result).\n","enum":["PASS","WARN","FAIL"],"example":"PASS","type":"string"},"vendor_code":{"description":"Machine-readable description of the individual check. This field contains vendor-specific terms and may not be populated in all cases.","example":"R940","type":"string"}},"readOnly":true,"type":"object"},"details":{"description":"A list of individual checks done as part of the due diligence process for the verification type.\n","items":{"$ref":"#/components/schemas/detail"},"readOnly":true,"type":"array"},"device_type":{"description":"The type of device into which the digital wallet token will be provisioned.","enum":["MOBILE_PHONE","WATCH","TABLET"],"type":"string"},"digital_wallet_token_address_verification":{"properties":{"validate":{"example":false,"type":"boolean"}},"type":"object"},"digital_wallet_token_edit_request":{"properties":{"token_status":{"description":"The status indicating the digital wallet token lifecycle state","enum":["ACTIVE","SUSPENDED","TERMINATED"],"type":"string"}},"required":["token_status"],"type":"object"},"digital_wallet_token_id":{"description":"The unique identifier of a digital wallet token","format":"string","type":"string"},"digital_wallet_token_response":{"properties":{"approved_time":{"example":"Sun May 01 2022 18:07:45 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"card_id":{"description":"Card ID of the Digital wallet Token","example":"0a53873a-ac57-49e0-a6ff-053213733fb1","format":"uuid","type":"string"},"device_id":{"description":"The user’s Android device ID; the device’s unique identifier.","maxLength":124,"type":"string"},"device_type":{"description":"Type of the device where the Digital Wallet Token is used in","enum":["MOBILE_PHONE","WATCH","TABLET","MOBILE_PHONE_OR_TABLET","VEHICLE","APPLIANCE","LAPTOP","GAMING_DEVICE","UNKNOWN"],"type":"string"},"id":{"description":"Digital Wallet Token ID","example":"d77ea883-aeb2-4292-8681-037b71665522","format":"uuid","type":"string"},"last_modified_time":{"example":"Tue Apr 26 2022 11:36:18 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"requested_time":{"example":"Mon May 16 2022 01:59:15 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/digital_wallet_token_state"},"type":{"description":"Type of the Digital Wallet","enum":["APPLE_PAY","ANDROID_PAY","SAMSUNG_PAY"],"type":"string"}},"type":"object"},"digital_wallet_token_state":{"description":"Current status of the Digital Wallet Token","enum":["REQUESTED","REQUEST_DECLINED","ACTIVE","SUSPENDED","TERMINATED"],"type":"string"},"digital_wallet_tokenization":{"properties":{"provisioning_controls":{"$ref":"#/components/schemas/provisioning_controls"}},"type":"object"},"disclosure":{"allOf":[{"required":["type","version","event_type","disclosure_date"]},{"$ref":"#/components/schemas/base_disclosure"}],"description":"Represents a disclosure.","type":"object"},"disclosure_list":{"allOf":[{"properties":{"disclosures":{"description":"Array of disclosures.","items":{"$ref":"#/components/schemas/disclosure"},"type":"array"}},"required":["disclosures"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"disclosure_response":{"description":"Represents all customer disclosures","properties":{"disclosures":{"description":"List of the customer's disclosures","items":{"$ref":"#/components/schemas/disclosure1"},"type":"array"}},"title":"List of Customer Disclosures","type":"object"},"disclosure_type":{"description":"Describes the regulatory requirement that triggered the disclosure.\nOne of the following:\n* `ACH_AUTHORIZATION` –\n    The ACH Authorization & Agreement Disclosure serves as a method of disclosing\n    and obtaining consent from a consumer to conduct ACH and pre-authorized\n    electronic transactions to and from their account. Record of obtaining this\n    consent should be retained, in accordance with Reg E, for no less than 2 years\n    from the date the disclosure was made to the consumer.\n* `CARDHOLDER_AGREEMENT` –\n    The Cardholder Agreement is a legal document that details the terms of a card\n    agreement between either a consumer or a business, and the financial\n    institution that issues the card. The Agreement governs the use of the\n    account.\n* `E_SIGN` –\n    US law with rules around electronic agreements/documents/disclosures:\n    used to obtain consent from consumers to receive electronic communications\n    (agreements, disclosures, statements, etc) about their accounts.\n* `KYC_DATA_COLLECTION` –\n    Document advising the customer that you will collect their personal information\n    (name, date of birth, tax ID, etc.)\n    and will be validating their information against external data/documentation.\n* `PRIVACY_NOTICE` –\n    Document that tells customers what is done with their non-public information,\n    who it is shared with, how is is secured,\n    and how they can opt out of it being shared beyond Synctera.\n* `REG_CC` –\n    US regulation that implements the Expedited Funds Availability Act:\n    describes standards for when a financial institution\n    makes funds available in a deposit account.\n* `REG_DD` –\n    US regulation that implements the Truth in Savings Act,\n    to inform customers about the terms and rules for a deposit account.\n* `REG_E` –\n    US regulation that implements the Electronic Funds Transfer Act:\n    covers liability for electronic transactions,\n    disputes for fraudulent or unrecognized electronic transactions,\n    and consent for electronic debits from a consumer's account.\n* `TERMS_AND_CONDITIONS` –\n    A detailed agreement between you and the consumer for the\n    structure, terms, fees, charges, rates of the product or service,\n    and the rules for the relationship between you and the consumer.\n","enum":["ACH_AUTHORIZATION","CARDHOLDER_AGREEMENT","E_SIGN","KYC_DATA_COLLECTION","PRIVACY_NOTICE","REG_CC","REG_DD","REG_E","TERMS_AND_CONDITIONS"],"type":"string"},"disclosure1":{"description":"Represents a disclosure","properties":{"creation_time":{"example":"2021-05-01T23:59:59Z","format":"date-time","readOnly":true,"type":"string"},"event_type":{"enum":["DISPLAYED","VIEWED","ACKNOWLEDGED"],"example":"VIEWED","type":"string"},"id":{"description":"Disclosure ID","example":"48c2a7f2-5edc-41e6-9f2a-fefac8e94659","format":"uuid","type":"string"},"last_updated_time":{"example":"2021-05-01T23:59:59Z","format":"date-time","readOnly":true,"type":"string"},"timestamp":{"description":"Date of disclosure","example":"2021-05-01T23:59:59Z","format":"date-time","type":"string"},"type":{"description":"Disclosure Type","enum":["ACH_AUTHORIZATION","CARDHOLDER_AGREEMENT","E_SIGN","KYC_DATA_COLLECTION","PRIVACY_NOTICE","REG_CC","REG_DD","REG_E","TERMS_AND_CONDITIONS"],"example":"REG_DD","type":"string"},"version":{"description":"Disclosure Version","example":"v1.1","type":"string"}},"required":["type","version","timestamp","event_type"],"title":"Disclosure","type":"object"},"dishonor_ach":{"description":"Dishonored return","properties":{"field_errors":{"items":{"enum":["account_number","original_trace_number","amount","identification_number","transaction_code","company_identification","effective_date"],"type":"string"},"type":"array"},"type":{"enum":["dishonored_misrouted","dishonored_erroneous_debit","dishonored_duplicate","dishonored_untimely","dishonored_field_errors","dishonored_not_requested"],"type":"string"}},"required":["type"],"type":"object"},"document":{"properties":{"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:04Z","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"A description of the attached document.","type":"string"},"encryption":{"$ref":"#/components/schemas/encryption"},"file_name":{"description":"The name of the document.","readOnly":true,"type":"string"},"id":{"description":"The unique identifier for this resource.","example":"d801427e-d927-4161-a054-81a02e8f6c86","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"The date and time the resource was last update.","example":"2021-06-14T11:23:04Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"description":"Optional field to store additional informaton about the resource.  Intended to be used by the integrator to store non-sensitive data.\n","type":"object"},"name":{"description":"A user-friendly name for the document.","type":"string"},"related_resource_id":{"description":"Related resource ID","format":"uuid","type":"string"},"related_resource_type":{"$ref":"#/components/schemas/related_resource_type"}},"type":"object"},"document_creation":{"properties":{"description":{"type":"string"},"encryption":{"$ref":"#/components/schemas/encryption"},"file":{"format":"binary","type":"string"},"metadata":{"description":"Optional field to store additional informaton about the resource.  Intended to be used by the integrator to store non-sensitive data.\n","type":"object"},"name":{"type":"string"},"related_resource_id":{"description":"Related resource ID","format":"uuid","type":"string"},"related_resource_type":{"$ref":"#/components/schemas/related_resource_type"}},"required":["file"],"type":"object"},"document_list":{"allOf":[{"properties":{"documents":{"description":"Array of documents.","items":{"$ref":"#/components/schemas/document"},"type":"array"}},"required":["documents"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"emboss_name":{"description":"The customer details to emboss on the card - Defaults to customer first and last name. Is limited to 21 characters. Valid characters are A-Z, a-z, 0-9, space ( ), period (.), comma (,), forward slash (/), hyphen (-), ampersand (&), single quote (').","properties":{"line_1":{"description":"line 1","example":"Krystal Bosco DVM","type":"string"},"line_2":{"description":"line 2","example":"Lesch, Schimmel and Green","type":"string"}},"required":["line_1"],"type":"object"},"employment":{"description":"A period of time in which a customer is (was) employed by a particular employer.\n","properties":{"employer_name":{"description":"Name of customer's employer.","example":"ABC, Inc.","type":"string"},"employment_from":{"description":"First day of employment.","example":"2016-05-11T00:00:00Z","format":"date-time","type":"string"},"employment_hours":{"description":"Number of hours spent per week working for specified employment.","example":37.5,"format":"float","maximum":80,"minimum":0,"type":"number"},"employment_income":{"description":"Annual income in cents.","example":5000000,"type":"integer"},"employment_income_currency":{"description":"The 3-letter alphabetic ISO 4217 code for the currency in which the employee was paid.\n","example":"USD","type":"string"},"employment_info":{"description":"A collection of arbitrary key-value pairs providing additional information about this employment relationship.\n","type":"object"},"employment_occupation":{"description":"Customer's work title, profession, or field.","example":"clerk","type":"string"},"employment_to":{"description":"Last day of employment.","example":"2018-11-19T00:00:00Z","format":"date-time","type":"string"},"id":{"description":"Unique ID for this employment relationship.","format":"uuid","readOnly":true,"type":"string"}},"required":["employer_name"],"title":"Customer employment record","type":"object"},"employment_list":{"allOf":[{"properties":{"employment":{"description":"Array of customer employment records.","items":{"$ref":"#/components/schemas/employment"},"type":"array"}},"required":["employment"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"encryption":{"default":"NOT_REQUIRED","enum":["REQUIRED","NOT_REQUIRED"],"type":"string"},"enhanced_transaction":{"description":"An unstructured JSON blob representing additional transaction information specific to each payment rail.","nullable":true,"type":"object"},"environment":{"description":"Indicates which environment the workspace belongs to","enum":["SANDBOX","LIVE_TESTING","PROD_LITE","PROD"],"type":"string"},"error":{"properties":{"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","example":"Bad Request Body","type":"string"},"type":{"description":"a URI that identifies this general category of error","example":"https://dev.synctera.com/errors/bad-request-body","type":"string"}},"title":"Standard error response (RFC 7807 problem report)","type":"object"},"event":{"description":"Webhook event object","properties":{"event_resource":{"description":"Json string of object associated with the event. For example, if your event is ACCOUNT.CREATED, You can refer to Acccount to parse the account event to obtain the ID, status etc.\n","type":"string"},"event_resource_changed_fields":{"description":"Json string of object associated with the event related to a resource change. This only contains those fields that have value changed on the event, and the field values are prior to the resource change event.\n","type":"string"},"event_time":{"description":"Timestamp of the current event raised","format":"date-time","type":"string"},"id":{"description":"Unique event ID of the webhook request. Use event endpoints to get more event summary data","format":"uuid","readOnly":true,"type":"string"},"metadata":{"description":"Metadata that stored in the webhook subscription","maxLength":1024,"type":"string"},"response_history":{"description":"Response history of the webhook request","items":{"$ref":"#/components/schemas/response_history_item"},"type":"array"},"status":{"description":"Current event status. Failing event will keep retry until it is purged.","enum":["RUNNING","SUCCESS","RETRYING"],"type":"string"},"type":{"$ref":"#/components/schemas/event_type_explicit"},"url":{"description":"URL that the current event will be sent to","maxLength":1024,"type":"string"},"webhook_id":{"description":"Webhook the current event belongs to","format":"uuid","type":"string"}},"title":"Webhook event","type":"object"},"event_list":{"allOf":[{"properties":{"event_list":{"description":"Array of events","items":{"$ref":"#/components/schemas/event"},"type":"array"}},"required":["event_list"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"event_resend":{"properties":{"event_id":{"description":"id of the event notification you want to resend","example":"a9561339-8b0f-43ed-a386-dc502c3c80f9","format":"uuid","type":"string"},"event_type":{"$ref":"#/components/schemas/event_type"}},"required":["event_type","event_id"],"type":"object"},"event_trigger":{"description":"Webhook event object that will be returned after triggering the given event. Only id, type and event_time will have value.","properties":{"event_resource":{"deprecated":true,"description":"Json string of object associated with the event. For example, if your event is ACCOUNT.CREATED, You can refer to Acccount to parse the account event to obtain the ID, status etc.\n","type":"string"},"event_resource_changed_fields":{"deprecated":true,"description":"Json string of object associated with the event related to a resource change. This only contains those fields that have value changed on the event, and the field values are prior to the resource change event.\n","type":"string"},"event_time":{"description":"Timestamp of the current event raised","format":"date-time","type":"string"},"id":{"description":"Unique event ID of the webhook request. Use event endpoints to get more event summary data","format":"uuid","readOnly":true,"type":"string"},"metadata":{"deprecated":true,"description":"Metadata that stored in the webhook subscription","maxLength":1024,"type":"string"},"response_history":{"deprecated":true,"description":"Response history of the webhook request","items":{"$ref":"#/components/schemas/response_history_item"},"type":"array"},"status":{"deprecated":true,"description":"Current event status. Failing event will keep retry until it is purged.","enum":["RUNNING","SUCCESS","RETRYING"],"type":"string"},"type":{"$ref":"#/components/schemas/event_type_explicit"},"url":{"deprecated":true,"description":"URL that the current event will be sent to","maxLength":1024,"type":"string"},"webhook_id":{"deprecated":true,"description":"Webhook the current event belongs to","format":"uuid","type":"string"}},"title":"Webhook event trigger","type":"object"},"event_type":{"description":"The reason for issuing/re-issuing a card","enum":["usertransition","businesstransition","cardtransition","transaction","digitalwallettokentransition","chargebacktransition","commandomodetransition","casetransition","directdeposittransition","banktransfertransition"],"type":"string"},"event_type_explicit":{"description":"All the webhook event types","enum":["ACCOUNT.CREATED","ACCOUNT.UPDATED","CARD.UPDATED","CARD.IMAGE.UPDATED","CUSTOMER.UPDATED","CUSTOMER.KYC_OUTCOME.UPDATED","BUSINESS.VERIFICATION_OUTCOME.UPDATED","PERSON.VERIFICATION_OUTCOME.UPDATED","INTEREST.MONTHLY_PAYOUT","INTERNAL_TRANSFER.SUCCEEDED","TRANSACTION.POSTED.CREATED","TRANSACTION.POSTED.UPDATED","TRANSACTION.PENDING.CREATED","TRANSACTION.PENDING.UPDATED","CARD.DIGITALWALLETTOKEN.CREATED","CARD.DIGITALWALLETTOKEN.UPDATED","PAYMENT_SCHEDULE.CREATED","PAYMENT_SCHEDULE.UPDATED","PAYMENT_SCHEDULE.PAYMENT.CREATED","STATEMENT.CREATED","EXTERNAL_CARD.CREATED"],"type":"string"},"event_type_wildcard":{"enum":["ACCOUNT.*","CARD.*","CUSTOMER.*","BUSINESS.*","PERSON.*","INTEREST.*","INTERNAL_TRANSFER.*","TRANSACTION.*","PAYMENT_SCHEDULE.*","STATEMENT.*","EXTERNAL_CARD.*"],"type":"string"},"event_type1":{"oneOf":[{"$ref":"#/components/schemas/event_type_explicit"},{"$ref":"#/components/schemas/event_type_wildcard"}]},"ext_account_customer_type":{"description":"The type of customer in the external financial institution. _Not_ necessarily the customer type on Synctera's platform: a business customer might link to the owner's personal account at an external financial institution.\n","enum":["PERSONAL","BUSINESS"],"type":"string"},"external_account":{"properties":{"account_identifiers":{"$ref":"#/components/schemas/account_identifiers"},"account_owner_names":{"description":"The names of the account owners. Values may be masked, in which case the array will be empty.\n","items":{"example":"Dr. Winston Zieme","type":"string"},"type":"array"},"business_id":{"description":"The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` will be returned.\n","example":"98f62347-33d0-4421-bfc0-91729390eff1","format":"uuid","type":"string"},"creation_time":{"example":"2022-01-01T00:00:00.000Z","format":"date-time","type":"string"},"customer_id":{"description":"The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` will be returned.\n","example":"e2197030-7aaf-472d-a454-5c1703d46417","format":"uuid","type":"string"},"id":{"description":"External account unique identifier","example":"90928aae-f478-443a-bdcc-00cf888df49b","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"example":"2022-01-01T00:00:00.000Z","format":"date-time","type":"string"},"metadata":{"description":"User-supplied JSON format metadata.","type":"object"},"name":{"description":"The official name of the account","example":"Plaid Checking","type":"string"},"nickname":{"description":"A user-meaningful name for the account","example":"Credit Card Account","nullable":true,"type":"string"},"routing_identifiers":{"$ref":"#/components/schemas/account_routing"},"status":{"description":"The current state of the account","enum":["ACTIVE","CLOSED"],"type":"string"},"type":{"description":"The type of the account","enum":["CHECKING","SAVINGS","CREDIT_CARD","MONEY_MARKET","INVESTMENT_529","OTHER"],"type":"string"},"vendor_data":{"$ref":"#/components/schemas/external_account_vendor_data"},"vendor_info":{"$ref":"#/components/schemas/vendor_info"},"verification":{"$ref":"#/components/schemas/account_verification"}},"required":["id","account_owner_names","status","type","routing_identifiers","account_identifiers","verification","creation_time","last_updated_time"],"title":"External account","type":"object"},"external_account_access_token":{"properties":{"business_id":{"description":"The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` must be specified.\n","example":"492c842f-7239-45cd-bc28-edf1a13c7de2","format":"uuid","type":"string"},"customer_id":{"description":"The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` must be specified.\n","format":"uuid","type":"string"},"request_id":{"description":"A unique identifier for the request, which can be used for troubleshooting","readOnly":true,"type":"string"},"vendor_access_token":{"description":"The access token associated with the Item data is being requested for.","readOnly":true,"type":"string"},"vendor_customer_id":{"description":"An alias for `customer_id` (deprecated).","format":"uuid","type":"string","x-status":"deprecated"},"vendor_institution_id":{"description":"The ID of the institution the access token is requested for\n","minLength":1,"type":"string"},"vendor_public_token":{"description":"The user's public token obtained from successful link login.\n","type":"string"}},"required":["vendor_public_token","vendor_institution_id"],"type":"object"},"external_account_balance":{"properties":{"available":{"description":"The available balance of the account","example":"Number in cents. E.g. 1000 represents $10.00","format":"int64","minimum":0,"nullable":true,"type":"integer"},"currency":{"description":"ISO 4217 alphabetic currency code","example":"FJD","type":"string"},"current":{"description":"The current balance of the account","example":"Number in cents. E.g. 1000 represents $10.00","format":"int64","minimum":0,"nullable":true,"type":"integer"},"limit":{"description":"The limit on the balance amount","example":"Number in cents. E.g. 1000 represents $10.00","format":"int64","minimum":0,"nullable":true,"type":"integer"}},"required":["currency"],"title":"External Account Balance","type":"object"},"external_account_link_token":{"properties":{"business_id":{"description":"The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` must be specified.\n","example":"d3087ca5-aaf9-4f7c-9241-58ab458e15ac","format":"uuid","type":"string"},"client_name":{"description":"The name of your application, as it should be displayed in Link. Maximum length of 30 characters.","type":"string"},"country_codes":{"description":"Country codes in the ISO-3166-1 alpha-2 country code standard.","items":{"enum":["US"],"type":"string"},"minItems":1,"type":"array"},"customer_id":{"description":"The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` must be specified.\n","example":"3d92aac9-bdf5-498f-96b0-e67da46be85e","format":"uuid","type":"string"},"expiration":{"description":"The expiration date for the link_token. Expires in 4 hours.","format":"date-time","readOnly":true,"type":"string"},"language":{"description":"The language that corresponds to the link token. For Plaid, see their [documentation](https://plaid.com/docs/api/tokens/#link-token-create-request-language) for a list of allowed values.\n","enum":["EN","FR","ES","NL","DE"],"type":"string"},"link_customization_name":{"description":"The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the default customization will be used. When using a Link customization, the language in the customization must match the language selected via the language parameter, and the countries in the customization should match the country codes selected via country_codes.\n","type":"string"},"link_token":{"description":"A link_token, which can be supplied to Link in order to initialize it and receive a public_token, which can be exchanged for an access_token.\n","readOnly":true,"type":"string"},"redirect_uri":{"description":"A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview.\n","type":"string"},"request_id":{"description":"A unique identifier for the request, which can be used for troubleshooting.","readOnly":true,"type":"string"},"sdk_type":{"default":"WEB","description":"Describes the environment of the client code running a vendor-supplied SDK","enum":["WEB","IOS","ANDROID"],"type":"string"},"type":{"description":"The type of the link token. DEPOSITORY for checking and savings accounts, CREDIT for credit card type accounts, INVESTMENT for investment accounts, and MICRO_DEPOSIT for depository accounts with support for micro-deposits verification.","enum":["DEPOSITORY","CREDIT","INVESTMENT","MICRO_DEPOSIT"],"type":"string"},"vendor_access_token":{"description":"The access token associated with the Item data is being requested for.","type":"string"},"vendor_institution_id":{"description":"The ID of the institution the access token is requested for. If present the link token will be created in an update mode.\n","minLength":1,"type":"string"},"verify_owner":{"default":false,"description":"If true, Synctera will attempt to verify that the external account owner is the same as the customer by comparing external account data to customer data. At least 2 of the following fields must match: name, phone number, email, address. Verification is disabled by default.\n","type":"boolean"}},"required":["client_name","language","country_codes","type"],"type":"object"},"external_account_transaction":{"properties":{"amount":{"description":"Transaction amount. Number in cents. E.g. 1000 represents $10.00","format":"int64","type":"integer"},"authorized_date":{"description":"Date that the transaction is authorized. ISO 8601 format ( YYYY-MM-DD ).","format":"date","nullable":true,"type":"string"},"category":{"description":"Category of the transaction","items":{"type":"string"},"type":"array"},"check_number":{"description":"Check number of the transaction. This field will be null if not a check transaction.","type":"string"},"currency":{"description":"ISO 4217 alphabetic currency code","example":"USD","type":"string"},"date":{"description":"For pending transactions, this represents the date of the transaction occurred; for posted transactions, this represents the date of the transaction posted. ISO 8601 format ( YYYY-MM-DD ).\n","format":"date","type":"string"},"is_pending":{"description":"Indicates the transaction is pending or unsettled if true.","type":"boolean"},"merchant_name":{"description":"Merchant name of the transaction","example":"Fancy store","type":"string"},"payment_channel":{"description":"channel used to make a payment","enum":["IN_STORE","ONLINE","OTHER"],"type":"string","x-enumDescriptions":[{"IN_STORE":"In store transaction."},{"ONLINE":"Online transaction."},{"OTHER":"Transactions that relate to banks, e.g. fees or deposits."}]},"payment_method":{"description":"Transfer type of the transaction, e.g. ACH","type":"string"},"transaction_id":{"description":"case-sensitive transaction ID","type":"string"}},"type":"object"},"external_account_vendor_data":{"properties":{"account_number_mask":{"description":"The last alphanumeric characters of an account's official account number. Note that the mask may be non-unique between accounts, and it may also not match the mask that the bank displays to the user.\n","type":"string"},"institution_id":{"description":"The ID of the institution external account belongs","type":"string"}},"type":"object"},"external_account_vendor_values":{"description":"The vendor selected for the operation.\n","enum":["PLAID","FINICITY"],"type":"string"},"external_accounts_list":{"allOf":[{"properties":{"external_accounts":{"description":"Array of external accounts","items":{"$ref":"#/components/schemas/external_account"},"type":"array"}},"required":["external_accounts"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"external_accounts_transaction_list":{"properties":{"transactions":{"description":"Array of transactions of a given external account","items":{"$ref":"#/components/schemas/external_account_transaction"},"type":"array"}},"required":["transactions"],"type":"object"},"external_card_id":{"description":"The unique identifier of external card","example":"7aeb712d-e9c7-42eb-965f-ce19507b17f8","format":"uuid","type":"string"},"external_card_list_response":{"allOf":[{"properties":{"external_cards":{"description":"Array of External Cards","items":{"$ref":"#/components/schemas/external_card_response"},"type":"array"}},"required":["external_cards"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"external_card_request":{"properties":{"business_id":{"$ref":"#/components/schemas/business_id"},"customer_id":{"$ref":"#/components/schemas/customer_id1"},"token":{"description":"The token that was returned via tokenization iframe","type":"string"}},"required":["token","customer_id"],"type":"object"},"external_card_response":{"properties":{"created_time":{"example":"2020-01-01T00:00:00.000Z","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/currency_code"},"customer_id":{"$ref":"#/components/schemas/customer_id1"},"expiration_month":{"example":"06","readOnly":true,"type":"string"},"expiration_year":{"example":"25","readOnly":true,"type":"string"},"id":{"description":"External card ID","type":"string"},"last_four":{"description":"The last 4 digits of the card PAN","example":"1234","readOnly":true,"type":"string"},"last_modified_time":{"example":"2020-01-01T00:00:00.000Z","format":"date-time","type":"string"},"name":{"description":"The external card holder name","example":"Jean Valjean","type":"string"},"verifications":{"$ref":"#/components/schemas/external_card_verifications"}},"required":["id","currency","customer_id","expiration_month","expiration_year","last_four","name"],"type":"object"},"external_card_verifications":{"description":"Verify card passed AVS and CVV checks in order to use PULL transfer. Verify card is eligible to receive push-to-card disbursements. For example, the inquiry_details object will contain a push_funds_block_indicator attribute that indicates if it is eligible for push-to-card disbursements.","properties":{"address_verification_results":{"description":"Address verification results\n\nStatus | Description\n--- | ---\nVERIFIED | Address verified\nNOT_VERIFIED | Address not verified\nADDRESS_NO_MATCH | Postal/ZIP match, street addresses do not match or street address not included in request\n","enum":["VERIFIED","NOT_VERIFIED","ADDRESS_NO_MATCH"],"type":"string"},"card_type":{"description":"Indicates whether the external card is credit, debit, prepaid, deferred debit, or charge.","enum":["CREDIT","DEBIT","CHARGE_PAID","PREPAID","DEFERRED_DEBIT"],"type":"string"},"cvv2_result":{"description":"Card Verification Value results\n\nStatus | Description\n--- | ---\nVERIFIED | CVV and expiration dates verified\nINCORRECT | Either CVV or expiration date is incorrect\nNOT_SUPPORTED | \tIssuer does not participate in CVV2 service\n","enum":["VERIFIED","INCORRECT","NOT_SUPPORTED"],"type":"string"},"fast_funds_indicator":{"description":"Indicates if card is Fast Funds eligible (i.e. if the funds will settle in 30 mins or less). If not eligible, typically funds will settle within 2 business days.","type":"boolean"},"online_gambling_block_indicator":{"description":"Indicates if the card can receive push-payments for online gambling payouts.","type":"boolean"},"processor":{"$ref":"#/components/schemas/processor"},"push_funds_block_indicator":{"description":"Indicates if the associated card can receive push-to-card disbursements.","type":"boolean"},"state":{"enum":["SUCCEEDED","FAILED"],"type":"string"}},"type":"object"},"external_data":{"description":"an unstructured json blob representing additional transaction information supplied by the integrator.","nullable":true,"type":"object"},"external_payment_date":{"description":"Principal’s date of birth","properties":{"day":{"description":"Day of birth","type":"integer"},"month":{"description":"Month of birth","type":"integer"},"year":{"description":"Year of birth","type":"integer"}},"required":["day","month","year"],"type":"object"},"fee":{"properties":{"amount":{"description":"Fee amount","format":"int64","type":"integer"},"currency":{"description":"Fee currency code in ISO 4217","pattern":"^[A-Z]{3}$","type":"string"},"fee_type":{"description":"Fee type","enum":["MONTHLY_FEE","ANNUAL_FEE","ATM_WITHDRWAL_FEE","OVERDRAFT_FEE","ACH_FEE","WIRE_FEE"],"type":"string"},"id":{"description":"Fee ID","format":"uuid","readOnly":true,"type":"string"},"product_type":{"enum":["INTEREST","FEE"],"type":"string"}},"required":["product_type","fee_type","amount","currency"],"type":"object"},"financial_institution":{"properties":{"legal_address":{"$ref":"#/components/schemas/address2"},"name":{"type":"string"},"phone_number":{"type":"string"}},"title":"Financial Institution","type":"object"},"financial_request_model":{"properties":{"amount":{"description":"The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"card_acceptor":{"$ref":"#/components/schemas/card_acceptor_model"},"card_id":{"format":"uuid","type":"string"},"cash_back_amount":{"description":"Cash back amount in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"is_pre_auth":{"default":false,"type":"boolean"},"mid":{"maxLength":50,"minLength":1,"type":"string"},"pin":{"maxLength":15,"minLength":1,"type":"string"},"transaction_options":{"$ref":"#/components/schemas/transaction_options"}},"required":["amount","card_acceptor","card_id","mid"],"type":"object"},"finicity_account_verification":{"allOf":[{"$ref":"#/components/schemas/base_account_verification"}],"title":"Information specific to Finicity verification"},"form":{"description":"PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string"},"fulfillment_details":{"properties":{"ship_date":{"description":"The date that the card was shipped as reported by the card fulfillment provider","example":"2022-07-19","format":"date","readOnly":true,"type":"string"},"shipping_method":{"description":"The specific shipping method as reported by the card fulfillment provider","example":"UPS Next Day Air Saver","readOnly":true,"type":"string"},"tracking_number":{"description":"The shipment tracking number","example":"1ZW3268W1319325382","readOnly":true,"type":"string"}},"type":"object"},"funding_source":{"properties":{"id":{"description":"Funding Source ID","example":"80a4541b-5450-41ce-8a2d-1baa427b0a3f","format":"uuid","readOnly":true,"type":"string"},"name":{"description":"Funding Source Name","readOnly":true,"type":"string"},"url":{"description":"Funding Source URL","readOnly":true,"type":"string"}},"type":"object"},"funding_source_response":{"allOf":[{"$ref":"#/components/schemas/funding_source"}],"required":["id","url","name"]},"funding_source_response_list":{"properties":{"funding_sources":{"description":"Array of funding sources","items":{"$ref":"#/components/schemas/funding_source_response"},"type":"array"}},"required":["funding_sources"],"type":"object"},"gateway_custom_headers":{"additionalProperties":{"type":"string"},"description":"Custom Headers of the Authorization gateway","type":"object"},"gateway_id":{"description":"The unique identifier of an Authorization gateway config","format":"string","type":"string"},"gateway_list_response":{"allOf":[{"properties":{"gateways":{"description":"Array of Authorization gateway configuration","items":{"$ref":"#/components/schemas/gateway_response"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"gateway_response":{"properties":{"active":{"description":"Current status of the Authorization gateway","type":"boolean"},"card_products":{"description":"List of Card Product unique identifiers that will utilize the Gateway","items":{"example":"a9bb2628-8d5c-476a-a78e-d32ebcabbd6f","format":"uuid","type":"string"},"type":"array"},"creation_time":{"description":"The timestamp representing when the gateway config request was made","example":"Fri Dec 17 2021 13:15:51 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"custom_headers":{"$ref":"#/components/schemas/gateway_custom_headers"},"id":{"description":"Gateway ID","example":"05da0ba1-0532-4805-9afd-bc09e0291bab","format":"uuid","type":"string"},"last_modified_time":{"description":"The timestamp representing when the gateway config was last modified at","example":"Sun Oct 17 2021 01:02:09 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"url":{"description":"URL of the Authorization gateway","format":"uri","maxLength":1000,"type":"string"}},"required":["id","active","url","card_products","creation_time","last_modified_time"],"type":"object"},"get_viral_loop_waitlists":{"description":"Get Viral Loop Waitlists","properties":{"lead_count":{"description":"total number of leads/people on the waitlist","minimum":0,"readOnly":true,"type":"integer"}},"type":"object"},"google_digital_wallet_provision_request":{"properties":{"device_id":{"description":"The user’s Android device ID; the device’s unique identifier.","maxLength":24,"type":"string"},"device_type":{"$ref":"#/components/schemas/device_type"},"provisioning_app_version":{"$ref":"#/components/schemas/provisioning_app_version"},"wallet_account_id":{"description":"The user’s Google wallet account ID.","maxLength":50,"type":"string"}},"required":["device_type","provisioning_app_version","wallet_account_id","device_id"],"type":"object"},"google_digital_wallet_provision_response":{"properties":{"card_id":{"$ref":"#/components/schemas/card_id"},"created_time":{"example":"Sat Feb 26 2022 07:31:38 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"last_modified_time":{"example":"Tue Nov 23 2021 12:04:53 GMT+0000 (Coordinated Universal Time)","format":"date-time","type":"string"},"push_tokenize_request_data":{"$ref":"#/components/schemas/push_tokenize_request_data"}},"type":"object"},"hold_cancel_request":{"properties":{"account_no":{"description":"The account number associated with the hold","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"reason":{"description":"The reason for the cancellation","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.","nullable":true,"type":"string"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["account_no","reason","user_data","external_data","risk_info","reference_id"],"title":"Hold Cancel Request","type":"object"},"hold_create_request":{"properties":{"account_no":{"description":"The account number associated with the hold","type":"string"},"allow_partial":{"type":"boolean"},"amount":{"description":"The amount of the hold.","format":"int64","minimum":0,"type":"integer"},"auto_post_at":{"description":"The time the transaction will be automatically posted.","format":"date-time","type":"string"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","type":"string"},"dc_sign":{"$ref":"#/components/schemas/dc_sign"},"decline_reason":{"description":"The reason for the decline, if any","type":"string"},"description":{"description":"The description of the transaction","type":"string"},"effective_date":{"description":"The effective date of the transaction once it gets posted","format":"date-time","type":"string"},"enhanced_transaction":{"$ref":"#/components/schemas/enhanced_transaction"},"expires_at":{"description":"The date that at which this hold is no longer valid.","format":"date-time","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"force_post":{"description":"Whether or not the hold was forced (spending controls ignored)","type":"boolean"},"memo":{"description":"A short note to the recipient","type":"string"},"network":{"description":"The network this transaction is associated with","type":"string"},"offset_description":{"description":"The description of the offset transaction","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.","nullable":true,"type":"string"},"status":{"description":"The status of the hold.","enum":["PENDING","DECLINED"],"type":"string"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"transaction_time":{"description":"The time the transaction occurred.","format":"date-time","type":"string"},"type":{"description":"The general type of transaction. For example, \"card\" or \"ach\".","type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["type","subtype","amount","dc_sign","expires_at","effective_date","currency","account_no","user_data","external_data","allow_partial","force_post","network","reference_id","memo","auto_post_at","status","decline_reason","transaction_time"],"title":"Hold Create Request","type":"object"},"hold_data":{"properties":{"amount":{"type":"integer"},"availability_time":{"example":"2022-03-18TT17:54:12Z","format":"date-time","type":"string"}},"required":["amount","availability_time"],"type":"object"},"hold_decline_request":{"properties":{"account_no":{"description":"The account number associated with the hold","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"reason":{"description":"The reason for the cancellation","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.","nullable":true,"type":"string"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["account_no","reason","user_data","external_data","risk_info","reference_id"],"title":"Hold Decline Request","type":"object"},"hold_modify_request":{"properties":{"account_no":{"description":"The account number associated with the hold","type":"string"},"allow_partial":{"type":"boolean"},"amount":{"description":"The amount of the hold.","format":"int64","minimum":0,"type":"integer"},"effective_date":{"description":"The effective date of the transaction once it gets posted","format":"date-time","type":"string"},"expires_at":{"description":"The date that at which this hold is no longer valid.","format":"date-time","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"force_post":{"description":"Whether or not the hold was forced (spending controls ignored)","type":"boolean"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["subtype","account_no","amount","expires_at","effective_date","allow_partial","user_data","external_data","risk_info","force_post"],"title":"Hold Modify Request","type":"object"},"hold_patch_request":{"properties":{"auto_post_at":{"description":"The time the transaction will be automatically posted.","format":"date-time","type":"string"},"enhanced_transaction":{"$ref":"#/components/schemas/enhanced_transaction"},"expires_at":{"description":"The date that at which this hold is no longer valid.","format":"date-time","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.","nullable":true,"type":"string"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["user_data","risk_info","external_data","expires_at","auto_post_at","reference_id","enhanced_transaction"],"title":"Hold Patch Request","type":"object"},"hold_posting_request":{"properties":{"account_no":{"description":"The account number associated with the hold","type":"string"},"amount":{"description":"The amount of the hold.","format":"int64","minimum":0,"type":"integer"},"effective_date":{"description":"The effective date of the transaction once it gets posted","format":"date-time","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"hold_amount":{"description":"The amount of the hold.","format":"int64","minimum":0,"type":"integer"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["subtype","account_no","amount","hold_amount","effective_date","user_data","external_data","risk_info"]},"id":{"description":"The unique identifier for this resource.","example":"b0888080-7759-40ae-b82b-5864ced6ad36","format":"uuid","readOnly":true,"type":"string"},"id_list_query_schema":{"example":"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157","items":{"format":"uuid","type":"string"},"type":"array"},"in_app_provisioning":{"properties":{"address_verification":{"$ref":"#/components/schemas/digital_wallet_token_address_verification"},"enabled":{"default":false,"example":false,"type":"boolean"}},"type":"object"},"ingestion_status":{"description":"Reconciliation ingestion status values","enum":["IN_PROCESS","COMPLETED","FAILED"],"title":"Reconciliation Ingestion Status Values","type":"string"},"interest":{"properties":{"accrual_payout_schedule":{"$ref":"#/components/schemas/accrual_payout_schedule"},"calculation_method":{"$ref":"#/components/schemas/calculation_method"},"description":{"description":"User provided description for the current interest.","example":"The rate is designed for high interest saving account.","type":"string"},"id":{"description":"Interest ID","format":"uuid","readOnly":true,"type":"string"},"product_type":{"enum":["INTEREST","FEE"],"type":"string"},"rates":{"$ref":"#/components/schemas/rates"}},"required":["product_type","calculation_method","rates","accrual_payout_schedule"],"type":"object"},"internal_account":{"properties":{"account_number":{"description":"Generated internal account number","maxLength":17,"minLength":14,"readOnly":true,"type":"string"},"balances":{"description":"A list of balances for internal account based on different type","items":{"$ref":"#/components/schemas/balance"},"readOnly":true,"type":"array"},"bank_routing":{"description":"Bank routing number","maxLength":9,"readOnly":true,"type":"string"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"Account currency or account settlement currency. ISO 4217 alphabetic currency code.","example":"VEF","pattern":"^[A-Z]{3}$","type":"string"},"description":{"description":"A user provided description for the current account","type":"string"},"gl_type":{"description":"Whether the account will represent assets or liabilities","enum":["ASSET","LIABILITY"],"type":"string"},"id":{"description":"Generated ID for internal account","format":"uuid","readOnly":true,"type":"string"},"is_system_acc":{"default":false,"description":"Is a system-controlled internal account","type":"boolean"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"status":{"enum":["ACTIVE"],"type":"string"}},"required":["status","currency"],"type":"object"},"internal_account_patch":{"properties":{"description":{"description":"A user provided description for the current account","type":"string"}},"type":"object"},"internal_accounts_list":{"allOf":[{"properties":{"internal_accounts":{"description":"Array of internal accounts","items":{"$ref":"#/components/schemas/internal_account"},"type":"array"}},"required":["internal_accounts"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"internal_transfer":{"example":{"amount":1025,"currency":"USD","originating_account_id":"1cde7350-f511-4a07-b314-06bf48a96a43","receiving_account_id":"921e1160-6227-4069-bd24-becf90390289","type":"ACCOUNT_TO_ACCOUNT"},"properties":{"amount":{"description":"The amount (in cents) to transfer from originating account to receiving account.","format":"int64","minimum":1,"type":"integer"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","example":"USD","type":"string"},"memo":{"description":"A short note to the recipient","type":"string"},"metadata":{"description":"Arbitrary key-value metadata to associate with the transaction","type":"object"},"originating_account_alias":{"description":"An alias representing a GL account to debit. This is alternative to specifying by account id","example":"ach_suspense","type":"string"},"originating_account_customer_id":{"description":"The customer id of the owner of the originating account.","format":"uuid","type":"string"},"originating_account_id":{"description":"The UUID of the account being debited","format":"uuid","type":"string"},"receiving_account_alias":{"description":"An alias representing a GL account to credit. This is an alternative to specifying by account id","example":"ach_suspense","type":"string"},"receiving_account_customer_id":{"description":"The customer id of the owner of the receiving account. Only required when type is \"outgoing_remittance\"","format":"uuid","type":"string"},"receiving_account_id":{"description":"The UUID of the account being credited","format":"uuid","type":"string"},"type":{"description":"The desired transaction type to use for this transfer","enum":["ACCOUNT_TO_ACCOUNT","ACH_CREDIT_SWEEP","ACH_DEBIT_SWEEP","ACH_FLOAT_TRANSFER","CASHBACK","FEE","INCOMING_WIRE","INTEREST_PAYOUT","MANUAL_ADJUSTMENT","MANUAL_ADJUSTMENT_REVERSAL","OUTGOING_INTERNATIONAL_REMITTANCE","OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL","PROMOTIONAL_CREDIT","SIGN_UP_BONUS","SUBSCRIPTION_FEE","TRANSFER_FEE","TRANSFER_FEE_REVERSAL"],"type":"string"}},"required":["amount","currency","type"],"type":"object"},"internal_transfer_instruction":{"properties":{"request":{"$ref":"#/components/schemas/internal_transfer"},"type":{"enum":["INTERNAL_TRANSFER"],"type":"string"}},"required":["type","request"],"type":"object"},"internal_transfer_response":{"allOf":[{"$ref":"#/components/schemas/internal_transfer"},{"properties":{"id":{"description":"The transaction id associated with the transfer","format":"uuid","type":"string"}},"required":["id"],"type":"object"}]},"is_customer":{"description":"True for personal and business customers with a direct relationship with the fintech or bank.","example":true,"type":"boolean"},"manual_account_verification":{"allOf":[{"$ref":"#/components/schemas/base_account_verification"}],"title":"Information specific to Manual verification"},"manual_entry":{"properties":{"address_verification":{"$ref":"#/components/schemas/digital_wallet_token_address_verification"},"enabled":{"default":false,"example":false,"type":"boolean"}},"type":"object"},"master_disclosure":{"allOf":[{"required":["type","version"]},{"$ref":"#/components/schemas/base_master_disclosure"}],"description":"Represents a document that must be shown to every party who is subject to a particular regulatory requirement (the _disclosure type_). The master disclosure record is the same for all such customers.\n","type":"object"},"master_disclosure_list":{"allOf":[{"properties":{"master_disclosures":{"description":"Array of master disclosures.","items":{"$ref":"#/components/schemas/master_disclosure"},"type":"array"}},"required":["master_disclosures"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"metadata":{"description":"Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.\n","type":"object"},"minimum_payment":{"description":"The scheme for calculating the minimum payment due for outstanding balances in a billing period.\n","discriminator":{"mapping":{"RATE_OR_AMOUNT":"#/components/schemas/minimum_payment_rate_or_amount"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/minimum_payment_rate_or_amount"}],"type":"object"},"minimum_payment_rate_or_amount":{"properties":{"min_amount":{"description":"The maximum amount to charge as a minimum payment, in cents. For example, to set the maximum to $30, set this value to 3000.\n","format":"int64","type":"integer"},"rate":{"description":"The percentage of the balance to use, in basis points. For example, to set 12.5% of the balance, set this value to 1250.\n","type":"integer"},"type":{"$ref":"#/components/schemas/minimum_payment_type","type":"string"}},"required":["type","rate","min_amount"],"type":"object"},"minimum_payment_type":{"description":"* RATE_OR_AMOUNT: >\n  Describes a minimum payment scheme where the amount calculated is either a portion\n  of the balance due, or a fixed, maximum amount, whichever is lesser. For example, if\n  set to 1.00% and $30, the minimum payment will be calculated as 1.00% of the balance,\n  but only up to a maximum of $30.\n","enum":["RATE_OR_AMOUNT"],"type":"string"},"monitoring_alert":{"properties":{"business_id":{"$ref":"#/components/schemas/business_id3"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T14:15:22Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"Unique identifier for this alert.","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"The date and time the resource was last update.","example":"2021-12-14T07:15:34Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"person_id":{"$ref":"#/components/schemas/person_id"},"status":{"$ref":"#/components/schemas/monitoring_status"},"type":{"description":"The type of customer alert. Any of the following:\n* `WATCHLIST` – the customer was added to a known watchlist.\n* `BANKRUPTCY` – the customer filed for bankruptcy.\n","enum":["WATCHLIST","BANKRUPTCY"],"readOnly":true,"type":"string"},"urls":{"description":"Where to get more information about this alert.","example":["https://example.com/alert-document-1","https://example.com/alert-document-2"],"items":{"type":"string"},"readOnly":true,"type":"array"},"vendor_info":{"$ref":"#/components/schemas/vendor_info"}},"type":"object"},"monitoring_alert_list":{"allOf":[{"properties":{"alerts":{"items":{"$ref":"#/components/schemas/monitoring_alert"},"type":"array"}},"required":["alerts"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"monitoring_status":{"description":"The status of the alert. Any of the following:\n* `ACTIVE` – alert has been issued and should be investigated.\n* `SUPPRESSED` – alert is a false positive, alert should be dismissed, or has been otherwise investigated.\n","enum":["ACTIVE","SUPPRESSED"],"type":"string"},"monitoring_subscription":{"properties":{"business_id":{"$ref":"#/components/schemas/business_id3"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T14:15:22Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"Unique identifier for this subscription.","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"The date and time the resource was last update.","example":"2021-12-14T07:15:34Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"person_id":{"$ref":"#/components/schemas/person_id"}},"type":"object"},"monitoring_subscription_list":{"allOf":[{"properties":{"subscriptions":{"items":{"$ref":"#/components/schemas/monitoring_subscription"},"type":"array"}},"required":["subscriptions"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"network_fee_model":{"example":{"amount":123,"credit_debit":"C","type":"ISSUER_FEE"},"properties":{"amount":{"description":"The amount of the fee in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"credit_debit":{"description":"C = credit; D = debit","enum":["C","D"],"type":"string"},"type":{"enum":["ISSUER_FEE","SWITCH_FEE","PINDEBIT_ASSOC_FEE","ACQUIRER_FEE","INTERCHANGE_FEE","CUR_CONV_CARDHOLDER_FEE","CUR_CONV_ISSUER_FEE","CROSS_BORDER_ISSUER_FEE"],"type":"string"}},"required":["type","amount"],"type":"object"},"original_credit_request_model":{"properties":{"amount":{"description":"The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"card_acceptor":{"$ref":"#/components/schemas/card_acceptor_model"},"card_id":{"format":"uuid","type":"string"},"mid":{"maxLength":50,"minLength":1,"type":"string"},"screening_score":{"type":"string"},"sender_data":{"$ref":"#/components/schemas/original_credit_sender_data"},"transactionPurpose":{"type":"string"},"type":{"enum":["account_to_account","person_to_person","prepaid","wallet_transfer","money_transfer_by_bank","business_to_business","disbursement","government_disbursement","gambling_payout","loyalty","merchant_disbursement","online_gambling_payout","pension_disbursement","prepaid_loads","card_bill_payment","bill_payment","cash_claim","cash_in","cash_out","mobile_air_time_payment","money_transfer_by_merchant","face_to_face_merchant_payment","government_payment","payments_goods_services"],"type":"string"}},"required":["amount","card_id","mid","type"],"type":"object"},"original_credit_sender_data":{"properties":{"funding_source":{"enum":["credit","debit","prepaid","deposit_account","cash","mobile_money_payment","non_visa_credit"],"type":"string"},"sender_account_number":{"type":"string"},"sender_account_type":{"enum":["other","rtn_bank_account","iban","card_account","email","phone_number","bank_account_number_and_identification_code","wallet_id","social_network_id"],"type":"string"},"sender_address":{"type":"string"},"sender_city":{"type":"string"},"sender_country":{"type":"string"},"sender_name":{"type":"string"},"sender_reference_number":{"type":"string"},"sender_state":{"type":"string"},"transaction_purpose":{"enum":["family_support","labor_transfers","travel","education","medical_treatment","emergency_need","savings","gifts","other","salary","lending","crypto_currency"],"type":"string"},"unique_transaction_reference_number":{"maxLength":17,"minLength":1,"type":"string"}},"required":["funding_source"],"type":"object"},"originating_account_id":{"description":"The unique identifier of an originating account","example":"a6f8870c-1e7e-45ba-833d-cbc1eead9d2d","format":"uuid","type":"string"},"outgoing_ach":{"description":"Represents a sent ACH transaction.","properties":{"account_name":{"description":"Receiving account name","example":"Bruce Wayne","type":"string"},"account_no":{"description":"Receiving account number","example":"122455799","type":"string"},"amount":{"description":"Transaction amount in cents","example":1560,"type":"integer"},"bank_id":{"example":1,"type":"integer"},"effective_date":{"description":"Effective date of the transaction","example":"2022-03-25","format":"date","type":"string"},"external_id":{"description":"Transaction ID in the ledger","example":"27f6473f-50fd-4dae-8c05-41b9bc3b4e3f","format":"uuid","type":"string"},"hold":{"$ref":"#/components/schemas/hold_data"},"id":{"example":"2cbc0558-e2c5-4ffa-b30c-44a1389d6920","format":"uuid","type":"string"},"is_same_day":{"description":"Was initiated as same-day ACH transaction","type":"boolean"},"memo":{"type":"string"},"partner_id":{"example":2,"type":"integer"},"reference_info":{"description":"Transaction reference info","type":"string"},"source_account_name":{"description":"Originating account name","example":"Thomas Anderson","type":"string"},"source_account_no":{"description":"Originating account number","example":"123638791329","type":"string"},"status":{"enum":["INIT","PENDING","CANCELED","COMPLETE","DECLINED"],"type":"string"},"trace_no":{"description":"Trace number of the transaction","example":"123456780000069","type":"string"}},"required":["id","bank_id","partner_id","external_id","account_no","amount","source_account_no","is_same_day","effective_date","trace_no","status","memo"],"type":"object"},"outgoing_ach_list":{"allOf":[{"properties":{"transactions":{"description":"Array of sent ACH transactions.","items":{"$ref":"#/components/schemas/outgoing_ach"},"type":"array"}},"required":["transactions"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"outgoing_ach_patch":{"description":"Update sent ach transaction","properties":{"funds_availability_time":{"example":"2022-03-18TT17:54:12Z","format":"date-time","type":"string"},"status":{"enum":["CANCELED"],"type":"string"}},"type":"object"},"outgoing_ach_request":{"description":"Send an ACH","properties":{"amount":{"description":"Amount to transfer in ISO 4217 minor currency units","example":607,"type":"integer"},"company_entry_description":{"description":"Company entry description ACH field. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose.","example":"PAYROLL","maxLength":10,"type":"string"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","example":"USD","type":"string"},"customer_id":{"description":"The customer's unique identifier","example":"2071f55a-0aeb-4f62-85a9-68f72856d463","format":"uuid","type":"string"},"dc_sign":{"description":"The type of transaction (debit or credit). A debit is a transfer in and a credit is a transfer out of the originating account","enum":["debit","credit"],"example":"debit","type":"string"},"effective_date":{"description":"Effective date transaction proccesses (is_same_day needs to be false or not present at all)","example":"2022-03-18","format":"date","type":"string"},"external_data":{"description":"Additional transfer metadata structured as key-value pairs","type":"object"},"final_customer_id":{"description":"ID of the international customer that receives the final remittance transfer (required for OFAC enabled payments)","format":"uuid","type":"string"},"hold":{"$ref":"#/components/schemas/ach_request_hold_data"},"id":{"example":"1f453c98-9c30-42b7-9835-cfc1e33f5e70","format":"uuid","readOnly":true,"type":"string"},"is_same_day":{"description":"Send as same day ACH transaction (use only is_same_day without specific effective_date)","type":"boolean"},"memo":{"description":"Memo for the payment","type":"string"},"originating_account_id":{"description":"The unique identifier for an originating account","example":"4394f57f-3396-4661-bd03-27684791611f","format":"uuid","type":"string"},"receiving_account_id":{"description":"The unique identifier for an receiving account","example":"18b1f30b-227f-4720-9956-4c6805e5cdfa","format":"uuid","type":"string"},"reference_info":{"description":"Will be sent to the ACH network and maps to Addenda record 05 - the recipient bank will receive this info","example":"Tempore atque et cum.","type":"string"},"risk":{"$ref":"#/components/schemas/risk_data","example":null}},"required":["customer_id","amount","currency","receiving_account_id","dc_sign","originating_account_id"],"title":"Send ACH requests","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":"d61grelm5f","type":"string"}},"title":"Paginated List response","type":"object"},"patch_account_product":{"discriminator":{"mapping":{"FEE":"#/components/schemas/fee","INTEREST":"#/components/schemas/patch_interest"},"propertyName":"product_type"},"oneOf":[{"$ref":"#/components/schemas/patch_interest"},{"$ref":"#/components/schemas/fee"}],"type":"object"},"patch_accounts_request_account_identifiers":{"properties":{"number":{"description":"The account number.\n","example":91981460,"minLength":1,"type":"string"}},"title":"Identifiers for the account","type":"object"},"patch_accounts_request_routing_identifiers":{"properties":{"ach_routing_number":{"description":"The routing number used for US ACH payments. On write, Synctera will store the entire routing number; on read, we only return the last 4 characters.\n","example":"756392185","minLength":1,"type":"string"},"bank_name":{"description":"The name of the bank managing the account","example":"Chase","minLength":1,"type":"string"}},"title":"Identifiers for the bank","type":"object"},"patch_ban_status":{"properties":{"ban_status":{"$ref":"#/components/schemas/ban_status"}},"required":["ban_status"]},"patch_business":{"allOf":[{"$ref":"#/components/schemas/base"}],"description":"Represents a business customer.","type":"object"},"patch_business_business_owner_relationship":{"allOf":[{"properties":{"additional_data":{"$ref":"#/components/schemas/additional_owner_data"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"from_business_id":{"description":"Unique ID for the subject business.\n","example":"0ffea3a5-1f5a-4b01-9135-bb41a9aad982","format":"uuid","type":"string"},"id":{"description":"Relationship unique identifier.","example":"9c762274-0043-4244-ac8f-24370e9af022","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"relationship_type":{"description":"The relationship type. One 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","enum":["BENEFICIAL_OWNER_OF","MANAGING_PERSON_OF","OWNER_OF"],"example":"BENEFICIAL_OWNER_OF","format":"enum","type":"string"},"to_business_id":{"description":"Unique ID for the related business.\n","example":"bc77f630-7d86-46b9-90e8-a9fced7eb240","format":"uuid","type":"string"}},"required":["relationship_type"]}],"description":"Denotes the relationship between specified businesses.","type":"object"},"patch_customer":{"description":"Customer object for patch purpose. All fields are optional","properties":{"dob":{"description":"Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD)","example":"2000-01-01","format":"date","type":"string"},"email":{"description":"Customer's email","example":"Hanna_Lubowitz@yahoo.com","type":"string"},"first_name":{"description":"Customer's first name","example":"Viva","type":"string"},"last_name":{"description":"Customer's last name","example":"Will","type":"string"},"legal_address":{"$ref":"#/components/schemas/address","description":"Customer's legal address"},"metadata":{"description":"User-supplied JSON format metadata. Do not use to store PII.","type":"object"},"middle_name":{"description":"Customer's middle name","example":"c","type":"string"},"phone_number":{"description":"Customer's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string"},"shipping_address":{"$ref":"#/components/schemas/address","description":"Customer's shipping address"},"ssn":{"description":"Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Must be compiled with ^\\d{3}-\\d{2}-\\d{4}$. Response contains the last 4 digits only (e.g. 6789).","example":"797-39-8489","type":"string"},"status":{"description":"Customer's status","enum":["ACTIVE","ESCHEAT","DECEASED","DENIED","DORMANT","FROZEN","INACTIVE","PROSPECT","SANCTION"],"type":"string"}},"title":"Customer","type":"object"},"patch_document":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"patch_external_account":{"properties":{"account_identifiers":{"$ref":"#/components/schemas/patch_accounts_request_account_identifiers"},"account_owner_names":{"description":"The names of the account owners.","items":{"example":"Monica Keebler","type":"string"},"type":"array"},"nickname":{"description":"A user-meaningful name for the account","example":"Money Market Account","minLength":1,"type":"string"},"routing_identifiers":{"$ref":"#/components/schemas/patch_accounts_request_routing_identifiers"},"type":{"description":"The type of the account","enum":["CHECKING","SAVINGS"],"type":"string"},"verification":{"$ref":"#/components/schemas/account_verification"}},"type":"object"},"patch_interest":{"properties":{"accrual_payout_schedule":{"$ref":"#/components/schemas/accrual_payout_schedule"},"calculation_method":{"$ref":"#/components/schemas/calculation_method"},"description":{"description":"User provided description for the current interest.","example":"The rate is designed for high interest saving account.","type":"string"},"id":{"description":"Interest ID","format":"uuid","readOnly":true,"type":"string"},"product_type":{"enum":["INTEREST"],"type":"string"},"rates":{"$ref":"#/components/schemas/rates"}},"required":["product_type"],"type":"object"},"patch_payment_schedule":{"description":"Patch request for payment schedule","properties":{"status":{"description":"Target payment schedule status","enum":["CANCELLED"],"type":"string"}},"type":"object"},"patch_person":{"allOf":[{"$ref":"#/components/schemas/base_person1"}],"description":"Person object for patch purpose.","type":"object"},"patch_person_business_owner_relationship":{"allOf":[{"properties":{"additional_data":{"$ref":"#/components/schemas/additional_owner_data"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"from_person_id":{"description":"Unique ID for the subject person.\n","example":"9e9673de-ad2d-44e9-9cb2-04cf1496b399","format":"uuid","type":"string"},"id":{"description":"Relationship unique identifier.","example":"04c2e531-d883-429e-8732-850d9d60a724","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"relationship_type":{"description":"The relationship type. One 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","enum":["BENEFICIAL_OWNER_OF","MANAGING_PERSON_OF","OWNER_OF"],"example":"BENEFICIAL_OWNER_OF","format":"enum","type":"string"},"to_business_id":{"description":"Unique ID for the related business.\n","example":"634a88c9-d282-4e69-9b12-62b9a6dec954","format":"uuid","type":"string"}},"required":["relationship_type"]}],"description":"Denotes the relationship between specified business and person.","type":"object"},"patch_person_business_relationship":{"allOf":[{"properties":{"additional_data":{"$ref":"#/components/schemas/additional_data"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"from_person_id":{"description":"Unique ID for the subject person.\n","example":"df0737e9-efc9-42a8-b26f-6efa4cac88c0","format":"uuid","type":"string"},"id":{"description":"Relationship unique identifier.","example":"c0e64981-dc1f-42d3-a7be-f7dfd369c019","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"relationship_type":{"description":"The relationship type. One 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","enum":["BENEFICIAL_OWNER_OF","MANAGING_PERSON_OF","OWNER_OF"],"example":"BENEFICIAL_OWNER_OF","format":"enum","type":"string"},"to_business_id":{"description":"Unique ID for the related business.\n","example":"5a5a9d68-bd44-4953-a5c8-35059c00e14d","format":"uuid","type":"string"}},"required":["relationship_type"]}],"description":"Denotes the relationship between specified person and business.","type":"object"},"patch_relationship_in":{"discriminator":{"mapping":{"BENEFICIAL_OWNER_OF":"#/components/schemas/patch_person_business_owner_relationship","MANAGING_PERSON_OF":"#/components/schemas/patch_person_business_relationship","OWNER_OF":"#/components/schemas/patch_business_business_owner_relationship"},"propertyName":"relationship_type"},"oneOf":[{"$ref":"#/components/schemas/patch_person_business_relationship"},{"$ref":"#/components/schemas/patch_person_business_owner_relationship"},{"$ref":"#/components/schemas/patch_business_business_owner_relationship"}],"type":"object"},"payment":{"description":"Executed payment","properties":{"description":{"description":"User provided description for the payment schedule","type":"string"},"error_details":{"$ref":"#/components/schemas/payment_error_details"},"id":{"description":"Payment ID","format":"uuid","type":"string"},"metadata":{"description":"User provided JSON format data for the payment schedule","type":"object"},"payment_date":{"$ref":"#/components/schemas/payment_date"},"payment_instruction":{"$ref":"#/components/schemas/payment_instruction"},"payment_schedule_id":{"description":"ID of the payment schedule that executed this payment","format":"uuid","type":"string"},"status":{"$ref":"#/components/schemas/payment_status"},"transaction_id":{"description":"Transaction ID. It will be included only when status is COMPLETED","format":"uuid","type":"string"}},"type":"object"},"payment_date":{"properties":{"execution_date":{"description":"Execution date for the next payment","format":"date","type":"string"},"scheduled_date":{"description":"Scheduled date for the next payment","format":"date","type":"string"}},"readOnly":true,"required":["scheduled_date","execution_date"],"type":"object"},"payment_error_details":{"description":"Payment error details. It will be included only when status is ERROR","properties":{"code":{"type":"string"},"details":{"type":"string"}},"type":"object"},"payment_instruction":{"discriminator":{"mapping":{"ACH":"#/components/schemas/ach_instruction","INTERNAL_TRANSFER":"#/components/schemas/internal_transfer_instruction"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ach_instruction"},{"$ref":"#/components/schemas/internal_transfer_instruction"}]},"payment_list":{"allOf":[{"properties":{"payments":{"description":"Array of payments","items":{"$ref":"#/components/schemas/payment"},"type":"array"}},"required":["payments"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"payment_schedule":{"description":"Payment schedule","properties":{"description":{"description":"User provided description for the payment schedule","type":"string"},"id":{"description":"Payment schedule ID","format":"uuid","readOnly":true,"type":"string"},"metadata":{"description":"User provided JSON format data","type":"object"},"next_payment_date":{"$ref":"#/components/schemas/payment_date"},"payment_instruction":{"$ref":"#/components/schemas/payment_instruction"},"schedule":{"$ref":"#/components/schemas/schedule_config"},"status":{"$ref":"#/components/schemas/payment_schedule_status"}},"required":["description","schedule","payment_instruction"],"type":"object"},"payment_schedule_list":{"allOf":[{"properties":{"payment_schedules":{"description":"Array of payment schedules.","items":{"$ref":"#/components/schemas/payment_schedule"},"type":"array"}},"required":["payment_schedules"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"payment_schedule_status":{"description":"Status of the payment schedule.\n","enum":["ACTIVE","EXPIRED","CANCELLED"],"readOnly":true,"type":"string","x-enumDescriptions":[{"ACTIVE":"Payment schedule will run the next payment"},{"EXPIRED":"Payment schedule has completed all the payments"},{"CANCELLED":"Payment schedule has cancelled all the future payments"}]},"payment_status":{"description":"Payment request status","enum":["COMPLETED","ERROR"],"type":"string"},"pending_transaction":{"properties":{"account_id":{"description":"The account id associated with the hold","example":"81f8799f-8888-496f-ad70-1f9ce6cf763b","type":"string"},"account_no":{"description":"The account number associated with the hold","type":"string"},"created":{"description":"The creation date of the hold","format":"date-time","type":"string"},"data":{"$ref":"#/components/schemas/pending_transaction_data"},"id":{"format":"int64","type":"integer"},"idemkey":{"description":"The idempotency key used when initially creating this hold.","type":"string"},"offset_account_id":{"description":"The offset account id associated with the hold","example":"8ade5876-e302-4cdc-b478-0c789e04e58f","type":"string"},"offset_account_no":{"description":"The offset account number associated with the hold","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction.","nullable":true,"type":"string"},"tenant":{"description":"The tenant associated with this hold, in the form \"<bankid>_<partnerid>\"","type":"string"},"updated":{"description":"The date the hold was last update","format":"date-time","type":"string"},"uuid":{"description":"The unique identifier of the hold transaction.","format":"uuid","type":"string"}},"required":["id","uuid","tenant","idemkey","account_no","account_id","created","updated","data","reference_id","offset_account_no","offset_account_id"],"title":"A pending transaction","type":"object"},"pending_transaction_data":{"properties":{"amount":{"description":"The amount of the hold.","format":"int64","minimum":0,"type":"integer"},"auto_post_at":{"description":"The account \"available balance\" at the time this hold was created","format":"date-time","type":"string"},"avail_balance":{"description":"The account \"available balance\" at the time this hold was created (to be deprecated)","format":"int64","type":"integer"},"available_balance":{"description":"The account \"available balance\" at the time this hold was created","format":"int64","type":"integer"},"balance":{"description":"The account balance at the time this hold was created","format":"int64","type":"integer"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","type":"string"},"dc_sign":{"$ref":"#/components/schemas/dc_sign"},"effective_date":{"description":"The effective date of the transaction once it gets posted","format":"date-time","type":"string"},"expires_at":{"description":"The date that at which this hold is no longer valid.","format":"date-time","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"force_post":{"description":"Whether or not the hold was forced (spending controls ignored)","type":"boolean"},"history":{"description":"An array representing any previous states of the hold, if it has been modified (For example, increasing or decreasing the hold amount).","items":{"$ref":"#/components/schemas/pending_transaction_history"},"type":"array"},"idemkey":{"description":"The idempotency key used when initially creating this hold.","type":"string"},"memo":{"description":"A short note to the recipient","type":"string"},"network":{"description":"The network this transaction is associated with","type":"string"},"operation":{"enum":["hold_new","hold_increase","hold_decrease","hold_replace","hold_decline","hold_cancel","hold_post"],"type":"string"},"reason":{"description":"If a hold has been declined or modified, this will include the reason.","type":"string"},"req_amount":{"description":"The requested amount, in the case of hold modifications.","format":"int64","minimum":0,"type":"integer"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"status":{"description":"The status of the hold.","enum":["PENDING","REPLACED","DECLINED","RELEASED","PARTCLEARD","EXPIRED","CLEARED","INTERNAL_ERROR"],"type":"string"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"total_amount":{"description":"The total amount of the hold. This may be different than `amount` in the case where a hold increase or decrease was requested.","format":"int64","minimum":0,"type":"integer"},"transaction_id":{"description":"The uuid of the transaction that this pending transaction originated from, if any. This is primary used when a transaction \"posts\", but a subset of the amount reserved until a future settlement date.","format":"uuid","type":"string"},"transaction_time":{"description":"The time that the transaction was created","format":"date-time","type":"string"},"type":{"description":"The general type of transaction. For example, \"card\" or \"ach\".","type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"},"was_partial":{"description":"Does this hold represent a partial debit (or credit)?","type":"boolean"}},"required":["memo","type","subtype","operation","idemkey","expires_at","effective_date","total_amount","amount","req_amount","dc_sign","currency","network","was_partial","force_post","status","reason","balance","avail_balance","available_balance","auto_post_at","risk_info","user_data","external_data","history","transaction_time"],"title":"Pending transaction data","type":"object"},"pending_transaction_history":{"properties":{"account_id":{"description":"The account id associated with the hold","example":"88564692-a977-4932-9b8d-6e2742d4b1a4","type":"string"},"account_no":{"description":"The account number associated with the hold","type":"string"},"created":{"description":"The creation date of the hold","format":"date-time","type":"string"},"data":{"$ref":"#/components/schemas/pending_transaction_history_data"},"id":{"format":"int64","type":"integer"},"idemkey":{"description":"The idempotency key used when initially creating this transaction.","type":"string"},"offset_account_id":{"description":"The offset account id associated with the hold","example":"f7a653cc-328e-49a8-83cc-1c1735ef5161","type":"string"},"offset_account_no":{"description":"The offset account number associated with the hold","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction.","nullable":true,"type":"string"},"tenant":{"description":"The tenant associated with this transaction, in the form \"<bankid>_<partnerid>\"","type":"string"},"updated":{"description":"The date the hold was last update","format":"date-time","type":"string"},"uuid":{"description":"The unique identifier of the hold transaction.","format":"uuid","type":"string"}},"required":["id","uuid","tenant","idemkey","account_no","account_id","created","updated","data","reference_id","offset_account_no","offset_account_id"],"title":"A pending transaction history","type":"object"},"pending_transaction_history_data":{"properties":{"amount":{"description":"The amount of the hold.","format":"int64","minimum":0,"type":"integer"},"auto_post_at":{"description":"The time the transaction will be automatically posted.","format":"date-time","type":"string"},"avail_balance":{"description":"The account \"available balance\" at the time this hold was created (to be deprecated)","format":"int64","type":"integer"},"available_balance":{"description":"The account \"available balance\" at the time this hold was created","format":"int64","type":"integer"},"balance":{"description":"The account balance at the time this hold was created","format":"int64","type":"integer"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","type":"string"},"dc_sign":{"$ref":"#/components/schemas/dc_sign"},"effective_date":{"description":"The effective date of the transaction once it gets posted","format":"date-time","type":"string"},"expires_at":{"description":"The date that at which this hold is no longer valid.","format":"date-time","type":"string"},"external_data":{"$ref":"#/components/schemas/external_data"},"force_post":{"description":"Whether or not the hold was forced (spending controls ignored)","type":"boolean"},"idemkey":{"description":"The idempotency key used when initially creating this hold.","type":"string"},"memo":{"description":"A short note to the recipient","type":"string"},"network":{"description":"The network this transaction is associated with","type":"string"},"operation":{"enum":["hold_new","hold_increase","hold_decrease","hold_replace","hold_decline","hold_cancel","hold_post"],"type":"string"},"reason":{"description":"If a hold has been declined or modified, this will include the reason.","type":"string"},"req_amount":{"description":"The requested amount, in the case of hold modifications.","format":"int64","minimum":0,"type":"integer"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"status":{"description":"The status of the hold.","enum":["PENDING","REPLACED","DECLINED","RELEASED","PARTCLEARD","EXPIRED","CLEARED","INTERNAL_ERROR"],"type":"string"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"total_amount":{"description":"The total amount of the hold. This may be different than `amount` in the case where a hold increase or decrease was requested.","format":"int64","minimum":0,"type":"integer"},"transaction_id":{"description":"The uuid of the transaction that this pending transaction originated from, if any. This is primary used when a transaction \"posts\", but a subset of the amount reserved until a future settlement date.","format":"uuid","type":"string"},"transaction_time":{"description":"The time the transaction occurred.","format":"date-time","type":"string"},"type":{"description":"The general type of transaction. For example, \"card\" or \"ach\".","type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"},"was_partial":{"description":"Does this hold represent a partial debit (or credit)?","type":"boolean"}},"required":["memo","type","subtype","operation","idemkey","expires_at","effective_date","total_amount","amount","req_amount","dc_sign","currency","network","was_partial","force_post","status","reason","balance","avail_balance","available_balance","transaction_time","risk_info","user_data","external_data","auto_post_at"],"title":"A pending transaction history data","type":"object"},"pending_transactions":{"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.","nullable":true,"type":"string"},"result":{"description":"List of pending transactions","items":{"$ref":"#/components/schemas/pending_transaction"},"type":"array"}},"required":["next_page_token","result"],"title":"Pending Transactions Response","type":"object"},"person":{"allOf":[{"required":["status","is_customer"]},{"$ref":"#/components/schemas/base_person1"}],"description":"Person object used in requests.","type":"object"},"person_business_owner_relationship":{"allOf":[{"required":["from_person_id","to_business_id","additional_data"]},{"$ref":"#/components/schemas/patch_person_business_owner_relationship"}],"description":"Denotes the relationship between specified person and business.","type":"object"},"person_business_relationship":{"allOf":[{"required":["from_person_id","to_business_id","additional_data"]},{"$ref":"#/components/schemas/patch_person_business_relationship"}],"description":"Denotes the relationship between specified person and business.","type":"object"},"person_id":{"description":"Unique ID for the person. Exactly one of `person_id` or `business_id` must be set.\n","example":"2c0bf949-9f59-4a04-82d4-9a86e0ccec2c","format":"uuid","type":"string"},"person_list":{"allOf":[{"properties":{"persons":{"description":"Array of persons.","items":{"$ref":"#/components/schemas/person"},"type":"array"}},"required":["persons"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"person1":{"properties":{"creation_time":{"format":"date-time","type":"string"},"first_name":{"type":"string"},"id":{"format":"uuid","type":"string"},"last_name":{"type":"string"},"last_updated_time":{"format":"date-time","type":"string"},"middle_name":{"type":"string"},"relationship_type":{"type":"string"}},"title":"Person","type":"object"},"physical_card":{"allOf":[{"$ref":"#/components/schemas/base_card"},{"properties":{"card_image_id":{"description":"The ID of the custom card image used for this card","example":"48c31767-938f-452e-a5d5-be07293c4407","format":"uuid","type":"string"},"shipping":{"$ref":"#/components/schemas/shipping"}},"type":"object"}],"description":"Details pertaining to issuing a new physical card","title":"Physical Card"},"physical_card_format":{"description":"The format of a physical card product","enum":["MAGNETIC_STRIPE","CHIP","CONTACT","CONTACTLESS","PHYSICAL_COMBO"],"type":"string"},"physical_card_issuance_request":{"allOf":[{"$ref":"#/components/schemas/physical_card"},{"required":["form","customer_id","account_id","type","card_product_id"],"type":"object"}],"example":{"account_id":"1471cad8-077a-4382-9e64-e28ea526fbaf","card_product_id":"aae9828b-c584-4971-86f9-c8ccc3ec3ad5","customer_id":"d947fe22-f70c-4797-90fa-6cceb1245db0","form":"PHYSICAL","type":"DEBIT"}},"physical_card_plus_status":{"allOf":[{"$ref":"#/components/schemas/physical_card"},{"$ref":"#/components/schemas/physical_card_response_status"}]},"physical_card_response":{"allOf":[{"$ref":"#/components/schemas/physical_card_plus_status"},{"properties":{"physical_card_format":{"$ref":"#/components/schemas/physical_card_format"}},"required":["form","id","customer_id","account_id","type","emboss_name","card_product_id","card_brand","creation_time","shipping","physical_card_format"],"type":"object"}]},"physical_card_response_status":{"allOf":[{"$ref":"#/components/schemas/card_status_object"},{"properties":{"card_fulfillment_status":{"$ref":"#/components/schemas/card_fulfillment_status"},"fulfillment_details":{"$ref":"#/components/schemas/fulfillment_details"},"tracking_number":{"deprecated":true,"description":"This contains all shipping details as provided by the card fulfillment provider, including the tracking\nnumber. This field is deprecated. Instead, please use the fulfillment_details object, which includes a\nfield for just the tracking number.\n","example":"Ship Date [2022-07-19], Shipping Method [UPS Next Day Air Saver]; Tracking Number [1ZW3268W1319325382]","readOnly":true,"type":"string"}},"required":["card_status","status_reason","card_fulfillment_status"],"type":"object"}]},"ping_response":{"properties":{"webhook_status":{"description":"status of webhook endpoint","example":"alive","type":"string"}},"required":["webhook_status"],"type":"object"},"plaid_account_verification":{"allOf":[{"$ref":"#/components/schemas/base_account_verification"}],"title":"Information specific to Plaid verification"},"posted_transaction":{"properties":{"created":{"description":"The creation date of the transaction","format":"date-time","type":"string"},"data":{"$ref":"#/components/schemas/posted_transaction_data"},"effective_date":{"description":"The \"effective date\" of a transaction. This may be earlier than posted_date in some cases (for example, a transaction that occurs on a Saturday may not be posted until the following Monday, but would have an effective date of Saturday)","format":"date-time","type":"string"},"id":{"format":"int64","type":"integer"},"idemkey":{"description":"The idempotency key used when initially creating this transaction.","example":"80e9e648-c016-421a-bab5-7f311c5a9fdd","type":"string"},"info_only":{"description":"Whether or not this transaction represents a purely informational operation or an actual money movement","type":"boolean"},"lead_mode":{"description":"Whether or not this transaction was created operating in \"lead ledger\" mode","type":"boolean"},"posted_date":{"description":"The date the transaction was posted. This is the date any money is considered to be added or removed from an account.","format":"date-time","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.","nullable":true,"type":"string"},"status":{"type":"string"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"tenant":{"description":"The tenant associated with this transaction, in the form \"<bankid>_<partnerid>\"","type":"string"},"transaction_time":{"description":"The time the transaction occurred.","format":"date-time","type":"string"},"type":{"description":"The general type of transaction. For example, \"card\" or \"ach\".","type":"string"},"updated":{"description":"The date the transaction was last updated","format":"date-time","type":"string"},"uuid":{"description":"The unique identifier of the transaction.","format":"uuid","type":"string"}},"required":["id","uuid","tenant","idemkey","type","subtype","status","info_only","lead_mode","data","posted_date","effective_date","transaction_time","created","updated","reference_id"],"title":"A posted transaction","type":"object"},"posted_transaction_data":{"properties":{"external_data":{"$ref":"#/components/schemas/external_data"},"force_post":{"description":"Whether or not the hold was forced (spending controls ignored)","type":"boolean"},"hold_id":{"description":"The uuid of the hold (pending transaction) that this transaction originated from, if any.","format":"uuid","type":"string"},"lines":{"description":"The set of accounting entries associated with this transaction. For example, a debit to a customer account will have a corresponding credit in a general ledger account.","items":{"$ref":"#/components/schemas/transaction_line1"},"type":"array"},"memo":{"description":"A short note to the recipient","type":"string"},"metadata":{"nullable":true,"type":"object"},"original_trx":{"description":"The \"original\" transaction that this transaction is related to. This is only populated in the case of reversed transactions.","format":"uuid","type":"string"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"user_data":{"description":"An unstructured JSON blob representing additional transaction information specific to each payment rail.","nullable":true,"type":"object"}},"required":["memo","user_data","external_data","risk_info","metadata","lines","force_post"],"type":"object"},"posted_transactions":{"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.","nullable":true,"type":"string"},"result":{"description":"List of posted transactions","items":{"$ref":"#/components/schemas/posted_transaction"},"type":"array"}},"required":["next_page_token","result"],"title":"Posted Transactions Response","type":"object"},"prefill_request":{"properties":{"ssn_filled":{"description":"If true, the person's SSN was successfully populated.","example":true,"readOnly":true,"type":"boolean"},"ssn_last4":{"description":"Last four digits of person's Social Security number (SSN).","example":4271,"type":"string"}}},"processor":{"description":"The transaction processor","enum":["VISA_V1","MASTERCARD_V1"],"example":"MASTERCARD_V1","type":"string"},"prospect":{"allOf":[{"properties":{"dob":{"description":"Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD)","example":"2000-01-01","format":"date","type":"string"},"first_name":{"description":"Customer's first name","example":"Chyna","type":"string"},"last_name":{"description":"Customer's last name","example":"Daugherty","type":"string"},"status":{"description":"Customer's status","enum":["ACTIVE","ESCHEAT","DECEASED","DENIED","DORMANT","FROZEN","INACTIVE","PROSPECT","SANCTION"],"type":"string"}},"required":["status"]},{"$ref":"#/components/schemas/base_person"}],"description":"A prospect has a unique identifier. It can be upgrade to a customer with required information","title":"Customer","type":"object"},"prospect_editable":{"properties":{"first_name":{"description":"First Name","example":"John","type":"string"},"last_name":{"description":"Last Name","example":"Smith","type":"string"},"metadata":{"description":"Client supplied json metadata to be stored with the prospect","example":"{'foo':'bar'}","type":"string"},"source":{"description":"Source of prospect","example":"email","type":"string"},"status":{"$ref":"#/components/schemas/prospect_status","readOnly":false}},"title":"Prospect","type":"object"},"prospect_status":{"description":"Status of the prospect","enum":["CREATED","VERIFIED","ADMITTED","WITHDRAWN"],"type":"string","x-enumDescriptions":[{"CREATED":"a newly created prospect that has not yet been verified"},{"VERIFIED":"a prospect that has been verified, e.g. the full name was collected, email address was validated, the prospect clicked on a verification link in an email, etc."},{"ADMITTED":"a prospect that has been converted into a customer"},{"WITHDRAWN":"a prospect that is no longer interested in becoming a customer"}]},"prospect1":{"allOf":[{"properties":{"creation_time":{"description":"Creation time","example":"2009-11-10 23:00:00 +0000 UTC","format":"date-time","readOnly":true,"type":"string"},"email":{"description":"Email","example":"someone@example.com","format":"email","type":"string"},"email_validation":{"enum":["PENDING","VALID","INVALID"],"readOnly":true,"type":"string","x-enumDescriptions":[{"PENDING":"email address is pending for validation"},{"VALID":"valid email address"},{"INVALID":"invalid email address"}]},"id":{"description":"Prospect ID","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"Most recent updated time","example":"2009-11-10 23:00:00 +0000 UTC","format":"date-time","readOnly":true,"type":"string"},"points":{"description":"Number of referral points","example":100,"type":"integer"},"recaptcha_token":{"description":"A token used to verify the user is not a robot","type":"string","writeOnly":true,"x-external":false},"referral_code":{"description":"Referral code","example":"BJDD302M","readOnly":true,"type":"string"},"referred_by":{"description":"UUID of the referrer","format":"uuid","readOnly":true,"type":"string"},"referred_by_code":{"description":"Referral code of the referrer","example":"gz82fxvz","type":"string"},"referred_prospects":{"description":"Number of people this prospect referred","readOnly":true,"type":"integer"},"vendor_info":{"$ref":"#/components/schemas/vendor_info","readOnly":true},"verification_token":{"description":"Verification token sent to prospect","example":"ABD37C31","readOnly":true,"type":"string"},"waitlist_id":{"description":"Waitlist ID","format":"uuid","readOnly":true,"type":"string"},"waitlist_position":{"description":"Prospect's number in the waitlist","example":1,"nullable":true,"readOnly":true,"type":"integer"}},"required":["email"],"type":"object"},{"$ref":"#/components/schemas/prospect_editable"}],"title":"Prospect"},"prospects_list":{"allOf":[{"properties":{"prospects":{"description":"Array of Prospects","items":{"$ref":"#/components/schemas/prospect1"},"type":"array"}},"required":["prospects"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}],"title":"Prospects List"},"provider_type":{"description":"Name of the organization that provided this data.","enum":["IDOLOGY","SOCURE"],"example":"SOCURE","type":"string"},"provisioning_app_version":{"description":"Version of the application making the provisioning request.","maxLength":50,"type":"string"},"provisioning_controls":{"properties":{"in_app_provisioning":{"$ref":"#/components/schemas/in_app_provisioning"},"manual_entry":{"$ref":"#/components/schemas/manual_entry"},"wallet_provider_card_on_file":{"$ref":"#/components/schemas/wallet_provider_card_on_file"}},"type":"object"},"push_tokenize_request_data":{"properties":{"display_name":{"type":"string"},"last_digits":{"type":"string"},"network":{"example":"mastercard","type":"string"},"opaque_payment_card":{"type":"string"},"token_service_provider":{"type":"string"},"user_address":{"$ref":"#/components/schemas/address1"}},"type":"object"},"quickstart_t10":{"properties":{"bank_id":{"description":"The ID of the bank partner works with within this program","type":"integer"},"partner_id":{"description":"The ID of the partner","type":"integer"}},"required":["partner_id","bank_id"],"type":"object"},"quickstart_t10_response":{"description":"T-10 cards config details","properties":{"card_products":{"description":"Array of card products created","items":{"$ref":"#/components/schemas/card_product_response"},"maxItems":3,"minItems":3,"type":"array"},"card_program":{"$ref":"#/components/schemas/card_program_response"}},"required":["card_program","card_products"],"type":"object"},"rate_details":{"properties":{"accrual_period":{"enum":["DAILY","MONTHLY"],"type":"string"},"rate":{"description":"Rate in basis points. E.g. 5 represents 0.05%","format":"int32","type":"integer"},"valid_from":{"description":"Rate effective start date. Inclusive.","format":"date","type":"string"},"valid_to":{"description":"Rate effective end date. Exclusive.","format":"date","type":"string"}},"required":["valid_from","rate","accrual_period"],"type":"object"},"rates":{"description":"A list of interest rate. Date intervals between valid_from and valid_to expect to have no overlap.\n","items":{"$ref":"#/components/schemas/rate_details"},"type":"array"},"raw_response":{"deprecated":true,"properties":{"provider":{"$ref":"#/components/schemas/provider_type"},"raw_data":{"description":"Raw data from an external provider, as a JSON string.","example":"{}","type":"string"}},"title":"Raw response from providers.","type":"object"},"recipient_name":{"description":"The name of the recipient to whom the card will be shipped","properties":{"first_name":{"example":"Thea","type":"string"},"last_name":{"example":"Ritchie","type":"string"},"middle_name":{"example":"a","type":"string"}},"required":["first_name","last_name"],"type":"object"},"reconciliation":{"description":"Reconciliation","properties":{"file_name":{"description":"Filename of the data to be reconciled","example":"vp1m0ynhxsm3nb","readOnly":true,"type":"string"},"id":{"description":"Reconciliation ID","example":"6b7f32f8-c469-41a5-86f0-c49fc172f019","format":"uuid","readOnly":true,"type":"string"},"ingestion_status":{"$ref":"#/components/schemas/ingestion_status"}},"required":["id","file_name","ingestion_status"],"title":"Reconciliation","type":"object"},"reconciliation_input":{"description":"Input data for a reconciliation","properties":{"byte_data":{"description":"Base64url encoded image","example":"npk0rpef411cbcc3smf07zsxh4z8e0ts9k95uzost1p5tgen697pw2rbunqr6zweqba4of7hrwakpwf56dtlf6y1b0ljcplt8p8txh1ef3usg67wa98toiudldulelnb9wnvogqscmpos5icmwdo5bknoficjxu1brtiuy0e7t3rss73ve21mb9vuhoeyuqr3pxyxw9y","format":"byte","type":"string"},"file_name":{"description":"Filename of the data to be reconciled","example":"cp2tj9tzpzpckc","type":"string"}},"required":["file_name","byte_data"],"title":"Reconciliation Input","type":"object"},"reconciliation_list":{"allOf":[{"properties":{"reconciliations":{"description":"Array of reconciliations","items":{"$ref":"#/components/schemas/reconciliation"},"type":"array"}},"required":["reconciliations"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"related_resource_type":{"description":"Related resource type","enum":["CUSTOMER","BUSINESS"],"type":"string"},"relationship":{"description":"The relationship of the account and the customer/business. Either customer_id OR business_id must be specified, but not both.","properties":{"business_id":{"description":"Business associated with the current account","format":"uuid","type":"string"},"customer_id":{"description":"Personal customer associated with the current account.","format":"uuid","type":"string"},"id":{"description":"ID of account relationship","format":"uuid","readOnly":true,"type":"string"},"person_id":{"deprecated":true,"description":"Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead.","format":"uuid","type":"string"},"relationship_type":{"$ref":"#/components/schemas/account_relationship_type"}},"required":["relationship_type"],"title":"Account Relationship","type":"object"},"relationship_in":{"discriminator":{"mapping":{"BENEFICIAL_OWNER_OF":"#/components/schemas/person_business_owner_relationship","MANAGING_PERSON_OF":"#/components/schemas/person_business_relationship","OWNER_OF":"#/components/schemas/business_business_owner_relationship"},"propertyName":"relationship_type"},"oneOf":[{"$ref":"#/components/schemas/person_business_relationship"},{"$ref":"#/components/schemas/person_business_owner_relationship"},{"$ref":"#/components/schemas/business_business_owner_relationship"}],"type":"object"},"relationship_list":{"allOf":[{"properties":{"relationships":{"description":"Array of relationships","items":{"$ref":"#/components/schemas/relationship"},"type":"array"}},"required":["relationships"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"relationship_role":{"description":"CUSTODIAN - Related party is the custodian e.g. the parent, BENEFICIARY - Related party is the beneficiary e.g. the dependent, PARTNER - Related party is the partner","enum":["CUSTODIAN","BENEFICIARY","PARTNER"],"example":"CUSTODIAN","title":"Relationship Role","type":"string"},"relationship1":{"properties":{"id":{"description":"ID of related entity","example":"821d3254-fed8-4fdc-aa35-7c1c770fd3cf","format":"uuid","type":"string"},"relationship_role":{"$ref":"#/components/schemas/relationship_role"}},"required":["id","relationship_role"],"title":"Relationship","type":"object"},"relationships_list":{"allOf":[{"properties":{"relationships":{"description":"Array of business/person relationships.","items":{"$ref":"#/components/schemas/relationship_in"},"type":"array"}},"required":["relationships"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"resend_response":{"properties":{"body":{"description":"response of the event notification","example":"usertransition response","type":"string"}},"type":"object"},"response_history_item":{"description":"Response history object of the webhook request","properties":{"code":{"description":"Response code from the request","type":"integer"},"response_body":{"description":"Response body from the request(Length more than 1024 will be trimmed)","type":"string"},"response_time":{"description":"Timestamp that the response is received","format":"date-time","type":"string"},"sent_time":{"description":"Timestamp that the request is sent","format":"date-time","type":"string"}},"title":"Response history","type":"object"},"return_ach":{"description":"Regular return","properties":{"type":{"enum":["insufficient_funds","acc_closed","acc_not_found","acc_invalid","unauthorized_corp_debit","return_requested","auth_revoked","payment_stopped","uncollected_funds","unauthorized_debit","failed_terms","account_sold","acc_frozen","fields_not_processable","improper_effective_date","non_transaction_account","credit_refused","duplicate_transaction","corp_receiver_unauthorized","permissible_return","source_document_presented","source_document_stop_payment","improper_source_document","state_law_affecting_acceptance","ineligible_or_improper_entry","item_stop_payment"],"type":"string"}},"required":["type"],"type":"object"},"reversal_model":{"example":{"amount":80,"find_original_window_days":6,"is_advice":false,"network_fees":[{"amount":123,"credit_debit":"C","type":"ISSUER_FEE"},{"amount":123,"credit_debit":"C","type":"ISSUER_FEE"}],"original_transaction_id":"original_transaction_id"},"properties":{"amount":{"description":"The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"find_original_window_days":{"format":"int32","type":"integer"},"is_advice":{"default":false,"type":"boolean"},"network_fees":{"items":{"$ref":"#/components/schemas/network_fee_model"},"type":"array"},"original_transaction_id":{"format":"uuid","type":"string"}},"required":["amount","original_transaction_id"],"type":"object"},"risk_data":{"properties":{"client_ip":{"description":"Client IP","type":"string"}},"type":"object"},"risk_info":{"description":"Information received by the transaction risk/fraud service related to this transaction","nullable":true,"type":"object"},"risk_rating":{"description":"Represents a customer's risk profile","properties":{"configuration_id":{"description":"The risk configuration id used in risk score calculation","format":"uuid","readOnly":true,"type":"string"},"id":{"description":"Risk rating ID","format":"uuid","readOnly":true,"type":"string"},"next_review":{"description":"The next review date where customer risk will be calculated","format":"date-time","type":"string"},"risk_level":{"description":"A textual representation of the customer risk score","enum":["low","medium","high"],"type":"string"},"risk_review":{"description":"The date the customer risk rating was calculated","format":"date-time","readOnly":true,"type":"string"},"risk_score":{"description":"The cumulative score of all risk rating fields","format":"float","type":"number"}},"title":"Customer Risk Rating","type":"object"},"risk_rating_list":{"allOf":[{"properties":{"risk_ratings":{"description":"Array of customer risk ratings","items":{"$ref":"#/components/schemas/risk_rating"},"type":"array"}},"required":["risk_ratings"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"savings_summary":{"description":"A summary of the accrued interest for the saving account in the current period","properties":{"apy":{"format":"float","type":"number"}},"title":"Saving Summary","type":"object"},"schedule_config":{"description":"Payment schedule recurrence configuration","properties":{"count":{"description":"Number of times to recur. Exactly one of end_date or count must be provided","format":"int32","minimum":1,"type":"integer"},"end_date":{"description":"End date of the schedule (exclusive). Exactly one of end_date or count must be provided","format":"date","type":"string"},"frequency":{"enum":["DAILY","WEEKLY","MONTHLY"],"type":"string"},"interval":{"description":"Interval between recurrences, e.g. interval = 2 with frequency = WEEKLY means every other week.","maximum":366,"minimum":1,"type":"integer"},"start_date":{"description":"Start date of the schedule (inclusive)","format":"date","type":"string"}},"required":["start_date","frequency","interval"],"type":"object"},"shipping":{"description":"Details about the shipping method. If supplied this will override the default shipping address of the customer or account.","properties":{"address":{"$ref":"#/components/schemas/address1","description":"The address to which the card will be shipped - Defaults to account shipping address if none supplied"},"care_of_line":{"description":"The name of the person to send in care of","type":"string"},"is_expedited_fulfillment":{"default":false,"description":"Is the shipment expedited","example":false,"type":"boolean"},"method":{"default":"LOCAL_MAIL","description":"The shipping method","enum":["LOCAL_MAIL","TWO_DAY","OVERNIGHT","INTERNATIONAL"],"example":"LOCAL_MAIL","type":"string"},"phone_number":{"description":"The phone number of the recipient","example":2007473385,"pattern":"^\\+[1-9]\\d{1,14}$","type":"string"},"recipient_name":{"$ref":"#/components/schemas/recipient_name","description":"The name of the recipient to whom the card will be shipped"}},"type":"object"},"simulate_card_fulfillment":{"properties":{"card_fulfillment_status":{"$ref":"#/components/schemas/card_fulfillment_status"}},"required":["card_fulfillment_status"],"type":"object"},"simulation_response_model":{"type":"object"},"single_use_token_request":{"properties":{"account_id":{"description":"The ID of the account to which the token will be linked","example":"9aea04bb-b7c7-46b5-817d-1af05e6b22f2","format":"uuid","type":"string"},"customer_id":{"description":"The ID of the customer to whom the token will be issued","example":"e167fa0d-ee40-4a6e-b1ba-f61593fd254e","format":"uuid","type":"string"}},"required":["customer_id","account_id"],"type":"object"},"single_use_token_response":{"example":{"customer_account_mapping_id":"user_token","expires":"2000-01-23T04:56:07.000+00:00","token":"token"},"properties":{"customer_account_mapping_id":{"type":"string"},"expires":{"description":"yyyy-MM-ddTHH:mm:ssZ","format":"date-time","type":"string"},"token":{"type":"string"}},"required":["expires"],"type":"object"},"socure_event_body":{"properties":{"environmentName":{"description":"Environment the event belongs to","type":"string"},"event":{"$ref":"#/components/schemas/socure_watchlist_result"},"id":{"description":"Unique identifier for the monitoring event","type":"string"}},"required":["id","environmentName","event"],"type":"object"},"socure_global_watchlist":{"properties":{"matches":{"$ref":"#/components/schemas/socure_matches"},"reasonCodes":{"description":"Array of reason codes","items":{"$ref":"#/components/schemas/socure_reason_code"},"type":"array"}},"required":["matches"],"type":"object"},"socure_match":{"properties":{"comments":{"properties":{"relatedURL":{"items":{"type":"string"},"type":"array"}},"type":"object"},"entityId":{"type":"string"},"matchFields":{"items":{"type":"string"},"type":"array"},"sourceUrls":{"items":{"type":"string"},"type":"array"},"status":{"type":"string"}},"required":["entityId","status"],"type":"object"},"socure_match_list":{"description":"Array of socure matches","items":{"$ref":"#/components/schemas/socure_match"},"type":"array"},"socure_matches":{"additionalProperties":{"$ref":"#/components/schemas/socure_match_list"},"description":"Contains key-value pair of the Source list name and an array of details about that match.","type":"object"},"socure_reason_code":{"description":"Applicable reason code for the transaction.","type":"string"},"socure_watchlist_result":{"description":"Encapsulates the relationship between a person and any number of watchlists. That is, this tells you which watchlists a person is believed to be on (there might be false positives for similar names).\n","properties":{"globalWatchlist":{"$ref":"#/components/schemas/socure_global_watchlist"},"referenceId":{"description":"A 36 character reference ID included with every ID+ response.","type":"string"}},"required":["referenceId"],"type":"object"},"spending_limit_with_time":{"description":"Limit over a specific time period.","properties":{"amount":{"description":"Maximum amount allowed within the time range. Unit in cents.","format":"int64","minimum":0,"type":"integer"},"transactions":{"description":"Maximum number of transactions allowed within the time range","format":"int64","minimum":0,"type":"integer"}},"type":"object"},"spending_limits":{"description":"Account spending limits","properties":{"day":{"$ref":"#/components/schemas/spending_limit_with_time"},"description":{"description":"User provided description on the spending limits","type":"string"},"lifetime":{"$ref":"#/components/schemas/spending_limit_with_time"},"month":{"$ref":"#/components/schemas/spending_limit_with_time"},"transaction":{"description":"Individual transaction limit","properties":{"amount":{"description":"Maximum amount allowed. Unit in cents.","format":"int64","minimum":0,"type":"integer"}},"type":"object"},"week":{"$ref":"#/components/schemas/spending_limit_with_time"}},"type":"object"},"ssn_source":{"description":"Describes the collection method for the customer's SSN:\n* `MANUAL` – the full 9 digits of the customer's SSN was collected.\n* `PREFILL` – the customer's SSN was collected using SSN Prefill.\n","enum":["MANUAL","PREFILL"],"readOnly":true,"type":"string"},"statement":{"allOf":[{"$ref":"#/components/schemas/base_statement"},{"properties":{"savings_summary":{"$ref":"#/components/schemas/savings_summary"}},"type":"object"}],"description":"A statement for a depository account","title":"Depository Statement"},"statement_list":{"allOf":[{"properties":{"statements":{"description":"Array of statements","items":{"$ref":"#/components/schemas/statement_summary"},"type":"array"}},"required":["statements"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}],"title":"Statement List"},"statement_summary":{"properties":{"account_id":{"description":"The unique identifier of the account the statement belongs to","format":"uuid","readOnly":true,"type":"string"},"due_date":{"description":"The limit date when the due amount indicated on the statement should be paid","format":"date","readOnly":true,"type":"string"},"end_date":{"description":"The date indicating the ending of the time interval covered by the statement","format":"date","readOnly":true,"type":"string"},"id":{"description":"statement ID","format":"uuid","readOnly":true,"type":"string"},"issue_date":{"description":"The date when the statement has been issued","format":"date","readOnly":true,"type":"string"},"start_date":{"description":"The date indicating the beginning of the time interval covered by the statement","format":"date","readOnly":true,"type":"string"}},"title":"Statement","type":"object"},"status":{"description":"The status of the account\n","enum":["APPLICATION_SUBMITTED","FAILED_KYC","ACCOUNT_NOT_DESIRED","ACTIVE_OR_DISBURSED","CLOSED","SUSPENDED","CHARGED_OFF","ACCOUNT_NEVER_ACTIVE","ACTIVATED_NOT_DISBURSED","AWAITING_FIXING","IN_CLOSING","RESTRICTED","DELINQUENT"],"title":"Account Status","type":"string"},"status1":{"description":"Status of the person. One of the following:\n* `ACTIVE` – is an integrator defined status.  Integrators should set a person 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 person is eligible for specific actions such as initiating transactions or issuing a card.\n* `DECEASED` – person is deceased.\n* `DENIED` – customer was turned down.\n* `DORMANT` – person is no longer active.\n* `ESCHEAT` – person's assets are abandoned and are property of the state.\n* `FROZEN` – person's actions are blocked for security, legal, or other reasons.\n* `INACTIVE` – an inactive status indicating that the person is no longer active.\n* `PROSPECT` – a potential customer, used for information-gathering and disclosures.\n* `SANCTION` – person is on a sanctions list and should be carefully monitored.\n","enum":["ACTIVE","DECEASED","DENIED","DORMANT","ESCHEAT","FROZEN","INACTIVE","PROSPECT","SANCTION"],"example":"ACTIVE","type":"string"},"template_fields":{"discriminator":{"mapping":{"CHECKING":"#/components/schemas/template_fields_depository","LINE_OF_CREDIT":"#/components/schemas/template_fields_line_of_credit","SAVING":"#/components/schemas/template_fields_depository"},"propertyName":"account_type"},"oneOf":[{"$ref":"#/components/schemas/template_fields_depository"},{"$ref":"#/components/schemas/template_fields_line_of_credit"}],"type":"object"},"template_fields_depository":{"allOf":[{"$ref":"#/components/schemas/base_template_fields"},{"properties":{"balance_ceiling":{"$ref":"#/components/schemas/balance_ceiling"},"balance_floor":{"$ref":"#/components/schemas/balance_floor"},"fee_product_ids":{"description":"A list of fee account products that the current account associates with.","items":{"format":"uuid","type":"string"},"type":"array"},"interest_product_id":{"description":"An interest account product that the current account associates with. The account product must have its calculation_method set to COMPOUNDED_MONTHLY.\n","format":"uuid","type":"string"},"is_ach_enabled":{"default":false,"description":"Enable ACH transaction.","type":"boolean"},"is_card_enabled":{"default":false,"description":"Enable card transaction.","type":"boolean"},"is_p2p_enabled":{"default":false,"description":"Enable P2P transaction.","type":"boolean"},"is_wire_enabled":{"default":false,"description":"Enable wire transaction.","type":"boolean"},"overdraft_limit":{"description":"Account's overdraft limit. Default is 0. Unit in cents.","format":"int64","minimum":0,"type":"integer"},"spending_limits":{"$ref":"#/components/schemas/spending_limits"}}}],"type":"object"},"template_fields_generic_response":{"properties":{"account_type":{"$ref":"#/components/schemas/account_type","type":"string"},"balance_ceiling":{"$ref":"#/components/schemas/balance_ceiling"},"balance_floor":{"$ref":"#/components/schemas/balance_floor"},"bank_country":{"description":"Bank country of the account","example":"US","pattern":"^[A-Z]{2,3}$","type":"string"},"billing_period":{"$ref":"#/components/schemas/billing_period"},"chargeoff_period":{"default":90,"description":"The number of days an account can stay delinquent before marking an account as charged-off.\n","minimum":0,"type":"integer"},"currency":{"description":"Account currency. ISO 4217 alphabetic currency code","example":"USD","pattern":"^[A-Z]{3}$","type":"string"},"delinquency_period":{"default":30,"description":"The number of days past the due date to wait for a minimum payment before marking an account as delinquent.\n","minimum":0,"type":"integer"},"fee_product_ids":{"description":"A list of fee account products that the current account associates with.","items":{"format":"uuid","type":"string"},"type":"array"},"grace_period":{"default":30,"description":"The number of days past the billing period to allow for payment before it is considered due. This directly infers the due date for a payment.\n","minimum":0,"type":"integer"},"interest_product_id":{"description":"An interest account product that the current account associates with.","format":"uuid","type":"string"},"is_ach_enabled":{"default":false,"description":"Enable ACH transaction on ledger.","type":"boolean"},"is_card_enabled":{"default":false,"description":"Enable card transaction on ledger.","type":"boolean"},"is_p2p_enabled":{"default":false,"description":"Enable P2P transaction on ledger.","type":"boolean"},"is_wire_enabled":{"default":false,"description":"Enable wire transaction on ledger.","type":"boolean"},"minimum_payment":{"$ref":"#/components/schemas/minimum_payment"},"overdraft_limit":{"description":"Account's overdraft limit. Default is 0. Unit in cents.","format":"int64","minimum":0,"type":"integer"},"spending_limits":{"$ref":"#/components/schemas/spending_limits"}},"required":["account_type","currency","bank_country"],"type":"object"},"template_fields_line_of_credit":{"allOf":[{"$ref":"#/components/schemas/base_template_fields"},{"properties":{"chargeoff_period":{"default":90,"description":"The number of days an account can stay delinquent before marking an account as charged-off.\n","minimum":0,"type":"integer"},"delinquency_period":{"default":30,"description":"The number of days past the due date to wait for a minimum payment before marking an account as delinquent.\n","minimum":0,"type":"integer"},"grace_period":{"default":30,"description":"The number of days past the billing period to allow for payment before it is considered due. This directly infers the due date for a payment.\n","minimum":0,"type":"integer"},"interest_product_id":{"description":"An interest account product that the current account associates with. The account product must have its calculation_method set to COMPOUNDED_DAILY.\n","format":"uuid","type":"string"},"minimum_payment":{"$ref":"#/components/schemas/minimum_payment"}},"required":["minimum_payment"]}],"type":"object"},"template_list":{"allOf":[{"properties":{"account_templates":{"description":"Array of account templates","items":{"$ref":"#/components/schemas/account_template_response"},"type":"array"}},"required":["account_templates"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"token_list":{"properties":{"digital_wallet_tokens":{"description":"Array of Digital Wallet Token information of a Card","items":{"$ref":"#/components/schemas/digital_wallet_token_response"},"type":"array"}},"type":"object"},"token_list_response":{"allOf":[{"$ref":"#/components/schemas/token_list"},{"$ref":"#/components/schemas/paginated_response"}],"required":["digital_wallet_tokens"]},"transaction":{"properties":{"data":{"$ref":"#/components/schemas/transaction_data"},"effective_date":{"description":"The \"effective date\" of a transaction. This may be earlier than posted_date in some cases (for example, a transaction that occurs on a Saturday may not be posted until the following Monday, but would have an effective date of Saturday)","format":"date-time","type":"string"},"id":{"type":"integer"},"posted_date":{"description":"The date the transaction was posted. This is the date any money is considered to be added or removed from an account.","format":"date-time","type":"string"},"status":{"type":"string"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"type":{"description":"The general type of transaction. For example, \"card\" or \"ach\".","type":"string"},"uuid":{"description":"The unique identifier of the transaction.","format":"uuid","type":"string"}},"required":["id","uuid","type","subtype","status","data","posted_date","effective_date"],"title":"A posted transaction","type":"object"},"transaction_data":{"properties":{"external_data":{"description":"an unstructured json blob representing additional transaction information supplied by the integrator.","type":"object"},"lines":{"description":"The set of accounting entries associated with this transaction. For example, a debit to a customer account will have a corresponding credit in a general ledger account.","items":{"$ref":"#/components/schemas/transaction_line"},"type":"array"},"memo":{"type":"string"},"metadata":{"type":"object"}},"required":["memo","lines"],"type":"object"},"transaction_direct_post_request":{"properties":{"account_alias":{"type":"string"},"account_no":{"description":"The account number associated with the transaction","type":"string"},"amount":{"description":"The amount of the hold.","format":"int64","minimum":0,"type":"integer"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","type":"string"},"dc_sign":{"$ref":"#/components/schemas/dc_sign"},"description":{"description":"The description of the transaction","type":"string"},"effective_date":{"description":"The effective date of the transaction once it gets posted","format":"date-time","type":"string"},"enhanced_transaction":{"$ref":"#/components/schemas/enhanced_transaction"},"external_data":{"$ref":"#/components/schemas/external_data"},"force_post":{"description":"Whether or not the hold was forced (spending controls ignored)","type":"boolean"},"info_only":{"description":"Whether or not this transaction represents a purely informational operation or an actual money movement","type":"boolean"},"memo":{"description":"A short note to the recipient","type":"string"},"network":{"description":"The network this transaction is associated with","type":"string"},"offset_description":{"description":"The description of the offset transaction","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.","nullable":true,"type":"string"},"risk_info":{"$ref":"#/components/schemas/risk_info"},"subtype":{"description":"The specific transaction type. For example, for `ach`, this may be \"outgoing_debit\".","type":"string"},"transaction_time":{"description":"The time the transaction occurred.","format":"date-time","type":"string"},"type":{"description":"The general type of transaction. For example, \"card\" or \"ach\".","type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"},"uuid":{"description":"The unique identifier of the transaction.","format":"uuid","type":"string"}},"required":["uuid","type","subtype","amount","account_no","account_alias","dc_sign","network","reference_id","currency","effective_date","force_post","user_data","external_data","memo","risk_info","info_only","transaction_time"],"title":"Direct Post Request","type":"object"},"transaction_line":{"properties":{"account_id":{"description":"The account uuid associated with this transaction line","example":"75c8658d-4ffc-46a2-b33f-50f785026060","type":"string"},"account_no":{"description":"The account number associated with this transaction line","type":"string"},"amount":{"description":"The amount (in cents) of the transaction","type":"integer"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","type":"string"},"dc_sign":{"$ref":"#/components/schemas/dc_sign"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid","account_no","account_id","amount","currency","dc_sign"],"type":"object"},"transaction_line1":{"properties":{"account_id":{"description":"The account uuid associated with this transaction line","example":"7f346df6-18b9-4b2f-9857-5f714ddd565e","type":"string"},"account_no":{"description":"The account number associated with this transaction line","type":"string"},"amount":{"description":"The amount (in cents) of the transaction","format":"int64","type":"integer"},"available_balance":{"description":"The account \"available balance\" at the point in time this transaction was posted","format":"int64","type":"integer"},"balance":{"description":"The account balance at the point in time this transaction was posted","format":"int64","type":"integer"},"created":{"description":"The creation date of the transaction","format":"date-time","type":"string"},"currency":{"description":"ISO 4217 alphabetic currency code of the transfer amount","type":"string"},"dc_sign":{"$ref":"#/components/schemas/dc_sign"},"is_fee":{"description":"Whether or not this line is considered a fee","type":"boolean"},"is_gl_acc":{"description":"Whether or not this line represents a GL account","type":"boolean"},"is_offset":{"description":"Whether or not this line is considered the \"offset\" line","type":"boolean"},"is_primary":{"description":"Whether or not this line is considered the \"primary\" line","type":"boolean"},"meta":{"nullable":true,"type":"object"},"network":{"description":"The network this transaction is associated with","type":"string"},"related_line":{"format":"int64","type":"integer"},"seq":{"format":"int64","type":"integer"},"tenant":{"description":"The tenant associated with this transaction, in the form \"<bankid>_<partnerid>\"","type":"string"},"updated":{"description":"The date the transaction was last updated","format":"date-time","type":"string"},"uuid":{"format":"uuid","type":"string"}},"required":["uuid","account_no","account_id","tenant","amount","dc_sign","seq","is_primary","is_offset","is_fee","is_gl_acc","related_line","currency","network","meta","balance","available_balance","created","updated"],"type":"object"},"transaction_options":{"properties":{"additional_data":{"type":"string"},"card_expiration_date_yymm":{"type":"string"},"database_transaction_timeout":{"format":"int32","type":"integer"},"encryption_key_id":{"type":"string"},"is_async":{"default":false,"type":"boolean"},"pre_auth_time_limit":{"type":"string"},"send_expiration_date":{"default":false,"type":"boolean"},"send_track_data":{"default":false,"type":"boolean"},"transaction_id":{"type":"string"},"transaction_timeout_threshold_seconds":{"format":"int64","type":"integer"}},"type":"object"},"transaction_reverse_request":{"properties":{"description":{"description":"The description of the transaction","type":"string"},"force_post":{"description":"Whether or not the hold was forced (spending controls ignored)","type":"boolean"},"offset_description":{"description":"The description of the offset transaction","type":"string"},"reason":{"description":"The reason for the reversal","type":"string"},"reference_id":{"description":"An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.","nullable":true,"type":"string"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["user_data","reason","force_post","reference_id"],"title":"Transaction Reverse Request","type":"object"},"transaction_update_meta_request":{"properties":{"external_data":{"$ref":"#/components/schemas/external_data"},"user_data":{"$ref":"#/components/schemas/user_data"}},"required":["user_data","external_data"],"title":"Transaction Update Meta Request","type":"object"},"transfer_list_response":{"allOf":[{"properties":{"external_transfers":{"description":"Array of External transfer","items":{"$ref":"#/components/schemas/transfer_response"},"type":"array"}},"required":["external_transfers"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"transfer_request":{"description":"Push to card or pull from card","properties":{"amount":{"description":"Amount of the transfer in cents","type":"integer"},"currency":{"$ref":"#/components/schemas/currency_code"},"external_card_id":{"description":"The ID of the external card from/to which the transfer will be initiated/received","example":"b2710751-b575-47d0-a09b-da0994553d93","format":"uuid","type":"string"},"originating_account_id":{"description":"The ID of the account to which the transfer will be initiated/received","example":"3e2a2f28-4910-4934-be22-ded51f926b76","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/transfer_type"}},"required":["originating_account_id","amount","currency","type","external_card_id"],"type":"object"},"transfer_response":{"properties":{"account_id":{"description":"The ID of the account to which the card will be linked","example":"a4037077-95cc-4746-806e-e19f32a2a5ab","format":"uuid","type":"string"},"amount":{"description":"Amount of the transfer in cents","type":"integer"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","type":"string"},"created_time":{"example":"2020-01-01T00:00:00.000Z","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/currency_code"},"customer_id":{"description":"The ID of the customer for which card is being activated","example":"a2d8305b-38bc-4f9e-a860-66b4ccbc52bc","format":"uuid","type":"string"},"id":{"description":"The id of the transfer","type":"string"},"last_modified_time":{"example":"2020-01-01T00:00:00.000Z","format":"date-time","type":"string"},"status":{"description":"The status of the transfer","enum":["SUCCEEDED","PENDING","FAILED"],"type":"string"},"transaction_id":{"description":"The transaction ID","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/transfer_type"}},"required":["account_id","id","amount","currency","status","customer_id","country_code","created_time","last_modified_time","type"],"type":"object"},"transfer_type":{"description":"Type of operation for transfer.\n\nType | Description\n--- | ---\nPUSH | Push fund to the external card from the account_id\nPULL | Pull funds from the external card to the account_id.\n","enum":["PULL","PUSH"],"example":"PULL","type":"string"},"txn_enhancer":{"default":"NONE","description":"whether to use a transaction enhancer and/or which vendor to use","enum":["NONE","MX"],"example":"NONE","type":"string"},"update_card_image_request":{"properties":{"rejection_memo":{"type":"string"},"rejection_reason":{"$ref":"#/components/schemas/card_image_rejection_reason"},"status":{"$ref":"#/components/schemas/card_image_status"}},"required":["status"],"type":"object"},"update_gateway_request":{"properties":{"active":{"description":"Current status of the Authorization gateway","type":"boolean"},"card_products":{"description":"List of Card Product unique identifiers that will utilize the Gateway","items":{"example":"0698ffec-3839-4ea2-8dc4-4bf4b514e4e7","format":"uuid","type":"string"},"type":"array"},"custom_headers":{"$ref":"#/components/schemas/gateway_custom_headers"},"url":{"description":"URL of the Authorization gateway","format":"uri","maxLength":1000,"type":"string"}},"type":"object"},"update_transfer":{"properties":{"status":{"description":"Field value must be set to CANCELED","enum":["CANCELED"],"example":"CANCELED","type":"string"}},"title":"Change Status","type":"object"},"user_data":{"description":"An unstructured JSON blob representing additional transaction information specific to each payment rail.","nullable":true,"type":"object"},"vendor_info":{"description":"The information provided to Synctera from the vendor. Interpretation of this object is up to the client.\n","discriminator":{"mapping":{"application/json":"#/components/schemas/vendor_json","text/xml":"#/components/schemas/vendor_xml"},"propertyName":"content_type"},"oneOf":[{"$ref":"#/components/schemas/vendor_json"},{"$ref":"#/components/schemas/vendor_xml"}],"title":"Vendor Info","type":"object"},"vendor_info1":{"description":"The information provided to Synctera from the vendor. Interpretation of this object is up to the client.\n","discriminator":{"mapping":{"application/json":"#/components/schemas/vendor_json","text/xml":"#/components/schemas/vendor_xml"},"propertyName":"content_type"},"oneOf":[{"$ref":"#/components/schemas/vendor_json"},{"$ref":"#/components/schemas/vendor_xml"}],"readOnly":true,"title":"Vendor Info","type":"object"},"vendor_json":{"properties":{"content_type":{"description":"Describes the content-type encoding received from the vendor","enum":["application/json"],"type":"string"},"json":{"description":"Data representation in JSON","type":"object"},"vendor":{"example":"SOCURE","type":"string"}},"required":["vendor","content_type","json"]},"vendor_xml":{"properties":{"content_type":{"description":"Describes the content-type encoding received from the vendor","enum":["text/xml"],"type":"string"},"vendor":{"example":"IDOLOGY","type":"string"},"xml":{"description":"Data representaion in XML","type":"string"}},"required":["vendor","content_type","xml"]},"verification":{"allOf":[{"required":["verification_type","verification_time","result"]},{"properties":{"business_id":{"$ref":"#/components/schemas/business_id5"},"creation_time":{"description":"The date and time the resource was created.","example":"2021-06-14T11:23:41Z","format":"date-time","readOnly":true,"type":"string"},"details":{"$ref":"#/components/schemas/details"},"id":{"description":"Unique ID for this verification result.","example":"379b0b05-bb49-4812-a9c9-3efe72df042f","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"The date and time the resource was last updated.","example":"2022-01-18T17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/metadata"},"person_id":{"$ref":"#/components/schemas/person_id"},"result":{"$ref":"#/components/schemas/verification_result"},"vendor_info":{"$ref":"#/components/schemas/vendor_info"},"verification_time":{"description":"The date and time the verification was completed.","format":"date-time","type":"string"},"verification_type":{"$ref":"#/components/schemas/verification_type1"}},"type":"object"}],"description":"Verification result.","type":"object"},"verification_list":{"allOf":[{"properties":{"verifications":{"description":"Array of verification results.","items":{"$ref":"#/components/schemas/verification"},"type":"array"}},"required":["verifications"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"verification_request":{"allOf":[{"required":["customer_consent"]},{"properties":{"business_id":{"$ref":"#/components/schemas/business_id5"},"customer_consent":{"description":"Whether this customer has consented to be verified.","type":"boolean"},"customer_ip_address":{"description":"The customer's IP address.","example":"63.239.107.232","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"},"document_id":{"description":"The ID of the uploaded government-issued identification document provided by the Socure SDK.\n","example":"1ab2c3de-fg45-6789-a01b-23c45678defg","type":"string"},"person_id":{"$ref":"#/components/schemas/person_id"}}}],"example":{"customer_consent":true,"customer_ip_address":"235.2.7.2","person_id":"1bb26bcb-0e1b-4060-972d-80891332aae2"},"type":"object"},"verification_result":{"description":"The determination of this verification. One of the following:\n* `PENDING` – verification is in progress for this customer.\n* `PROVISIONAL` – partially verified or verified with restrictions.\n* `ACCEPTED` – the customer has been verified.\n* `REVIEW` – verification has run and issues have been identified and require review.\n* `VENDOR_ERROR` – verification did not successfully run due to an unexpected error or failure.\n* `REJECTED` – the customer was rejected and should not be allowed to take certain actions e.g., open an account.\n","enum":["PENDING","PROVISIONAL","ACCEPTED","REVIEW","VENDOR_ERROR","REJECTED"],"example":"ACCEPTED","type":"string"},"verification_status":{"description":"The result of a KYC/KYB verification. One of the following:\n* `UNVERIFIED` – verification has not been completed for this customer.\n* `PENDING` – verification is in progress for this customer.\n* `PROVISIONAL` – partially verified or verified with restrictions.\n* `ACCEPTED` – the customer has been verified.\n* `REVIEW` – verification has run and issues have been identified and require review.\n* `REJECTED` – the customer was rejected and should not be allowed to take certain actions e.g., open an account.\n","enum":["UNVERIFIED","PENDING","PROVISIONAL","ACCEPTED","REVIEW","REJECTED"],"example":"ACCEPTED","readOnly":true,"type":"string"},"verification_type":{"description":"The type of check run on the customer.","enum":["fraud","synthetic","emailrisk","phonerisk","addressrisk","kyc","social","watchliststandard","watchlistpremier","watchlistplus","documentverification","alertlist","decision"],"example":"kyc","type":"string"},"verification_type1":{"description":"The verification run on the customer. One the following:\n  * `IDENTITY` – verify that the information provided is associated with the identity of a real person or business.\n  * `WATCHLIST` – checks watchlists for known fraud, money laundering, and other suspicious activity.\n  * `RELATED_ENTITIES` – represents dependent verification checks for related parties (e.g. all beneficial owners must pass KYC for a business to pass KYB).\n  * `MANUAL_REVIEW` – represents the outcome of a manual review of the verification done on a party (note: overrides the outcome of other verification types).\n","enum":["IDENTITY","WATCHLIST","RELATED_ENTITIES","MANUAL_REVIEW"],"example":"IDENTITY","type":"string"},"verification_vendor_info":{"description":"The information provided to Synctera from the vendor. Interpretation of this object is up to the client.\n","discriminator":{"mapping":{"application/json":"#/components/schemas/verification_vendor_json","text/xml":"#/components/schemas/verification_vendor_xml"},"propertyName":"content_type"},"oneOf":[{"$ref":"#/components/schemas/verification_vendor_json"},{"$ref":"#/components/schemas/verification_vendor_xml"}],"type":"object"},"verification_vendor_info_detail":{"properties":{"code":{"description":"Vendor specific code.","example":"R186","type":"string"},"description":{"description":"Description of vendor specific code.","example":"Global Watchlist sources selected are correlated with the input identifiers","type":"string"}},"type":"object"},"verification_vendor_json":{"properties":{"content_type":{"description":"Describes the content-type encoding received from the vendor.","enum":["application/json"],"type":"string"},"details":{"description":"Array of vendor specific information.","items":{"$ref":"#/components/schemas/verification_vendor_info_detail"},"readOnly":true,"type":"array"},"json":{"description":"Data representation in JSON.","type":"object"},"vendor":{"description":"Name of the vendor used.","example":"SOCURE","type":"string"}},"required":["vendor","content_type","json"]},"verification_vendor_xml":{"properties":{"content_type":{"description":"Describes the content-type encoding received from the vendor.","enum":["text/xml"],"type":"string"},"details":{"description":"Array of vendor specific information.","items":{"$ref":"#/components/schemas/verification_vendor_info_detail"},"readOnly":true,"type":"array"},"vendor":{"description":"Name of the vendor used.","example":"IDOLOGY","type":"string"},"xml":{"description":"Data representaion in XML.","type":"string"}},"required":["vendor","content_type","xml"]},"verify_response":{"allOf":[{"properties":{"verification_status":{"$ref":"#/components/schemas/verification_status"},"verifications":{"description":"Array of verification results.","items":{"$ref":"#/components/schemas/verification"},"type":"array"}},"required":["verification_status","verifications"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"version":{"description":"Version of the disclosure document.","example":"1.0","pattern":"^[0-9]+\\.[0-9]+$","type":"string"},"viral_loop_waitlists":{"description":"Viral Loop Waitlists","properties":{"bank_id":{"description":"Bank ID","readOnly":true,"type":"integer"},"creation_time":{"description":"Creation time","example":"2009-11-10 23:00:00 +0000 UTC","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"Viral Loop Waitlist ID","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"Most recent updated time","example":"2009-11-10 23:00:00 +0000 UTC","format":"date-time","readOnly":true,"type":"string"},"lead_count":{"description":"Total number of leads/people on the waitlist","minimum":0,"readOnly":true,"type":"integer"},"partner_id":{"description":"Partner ID","readOnly":true,"type":"integer"},"viral_loop_api_token":{"description":"viral loop api token","minLength":5,"type":"string","writeOnly":true}},"required":["id","viral_loop_api_token"],"type":"object"},"virtual_card":{"allOf":[{"$ref":"#/components/schemas/base_card"}],"description":"A virtual card","title":"Virtual Card"},"virtual_card_issuance_request":{"allOf":[{"$ref":"#/components/schemas/virtual_card"},{"required":["form","customer_id","account_id","type","card_product_id"],"type":"object"}],"example":{"account_id":"378b3add-0045-4b07-8907-b5fff54f1858","card_product_id":"83ba2733-3fdd-49f2-bf79-c73b1ffa7437","customer_id":"122c0a4e-f955-4281-a5d9-bdd309776851","form":"VIRTUAL","type":"DEBIT"}},"virtual_card_plus_status":{"allOf":[{"$ref":"#/components/schemas/virtual_card"},{"$ref":"#/components/schemas/virtual_card_response_status"}]},"virtual_card_response":{"allOf":[{"$ref":"#/components/schemas/virtual_card_plus_status"},{"required":["form","id","customer_id","account_id","type","emboss_name","last_four","card_product_id","card_brand","expiration_year","expiration_month","creation_time"],"type":"object"}]},"virtual_card_response_status":{"allOf":[{"$ref":"#/components/schemas/card_status_object"},{"required":["card_status","status_reason"],"type":"object"}]},"waitlist":{"allOf":[{"description":"Waitlist","properties":{"creation_time":{"description":"Creation time","example":"2009-11-10 23:00:00 +0000 UTC","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"Waitlist ID","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"description":"Most recent updated time","example":"2009-11-10 23:00:00 +0000 UTC","format":"date-time","readOnly":true,"type":"string"},"num_admitted":{"description":"Current number of prospects in this waitlist with a status of admitted","example":100,"readOnly":true,"type":"integer"},"num_created":{"description":"Current number of prospects in this waitlist with a status of created","example":100,"readOnly":true,"type":"integer"},"num_prospects":{"description":"Current number of prospects in this waitlist, in any state","example":1000,"readOnly":true,"type":"integer"},"num_verified":{"description":"Current number of prospects in this waitlist with a status of verified","example":700,"readOnly":true,"type":"integer"},"num_withdrawn":{"description":"Current number of prospects in this waitlist with a status of withdrawn","example":100,"readOnly":true,"type":"integer"}},"required":["increment","waitlist_name"],"type":"object"},{"$ref":"#/components/schemas/waitlist_editable"}],"title":"Waitlist"},"waitlist_analytics":{"description":"Daily Waitlist Analytics","properties":{"admitted":{"description":"Total number of prospects that were admitted on the given day","example":100,"readOnly":true,"type":"integer"},"created":{"description":"Total number of prospects that signed up on the given day","example":103,"readOnly":true,"type":"integer"},"date":{"description":"Date","example":"2021-05-17","readOnly":true,"type":"string"},"deleted":{"description":"Total number of prospects that were deleted on the given day","example":2,"readOnly":true,"type":"integer"},"verified":{"description":"Total number of prospects that were verified on the given day","example":50,"readOnly":true,"type":"integer"},"withdrawn":{"description":"Total number of prospects that were withdrawn on the given day","example":5,"readOnly":true,"type":"integer"}},"title":"Waitlist Analytics","type":"object"},"waitlist_analytics_list":{"properties":{"waitlist_analytics":{"description":"Array of Waitlist Analytics","items":{"$ref":"#/components/schemas/waitlist_analytics"},"type":"array"}},"required":["waitlist_analytics"],"title":"Waitlist Analytics List","type":"object"},"waitlist_editable":{"description":"Waitlist fields that can be specified in a PATCH operation","properties":{"description":{"description":"Waitlist Name","example":"New Account Type Waitlist","type":"string"},"increment":{"description":"Number of points earned per verified referral","example":10,"type":"integer"},"max_prospects":{"description":"Max number of prospects allowed on this waitlist. Default is 10,000,000.","example":2000,"type":"integer"},"waitlist_name":{"description":"Waitlist Name","example":"My Waitlist","type":"string"}},"title":"Waitlist","type":"object"},"waitlists_list":{"allOf":[{"properties":{"waitlists":{"description":"Array of Waitlists","items":{"$ref":"#/components/schemas/waitlist"},"type":"array"}},"required":["waitlists"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}],"required":["waitlists"],"title":"Waitlist List","type":"object"},"wallet_provider_card_on_file":{"properties":{"address_verification":{"$ref":"#/components/schemas/digital_wallet_token_address_verification"},"enabled":{"default":false,"example":false,"type":"boolean"}},"type":"object"},"watchlist_alert":{"properties":{"created":{"description":"When this alert was created","format":"date-time","type":"string"},"id":{"description":"Unique identifier for this alert","format":"uuid","type":"string"},"provider_info":{"description":"The information provided to Synctera that triggered this alert, as an arbitrary JSON object. Interpretation of this object is up to the client.\n","type":"object"},"provider_subject_id":{"description":"The id of the provider subject for this alert","type":"string"},"provider_subscription_id":{"description":"The id of the provider subscription for this alert","type":"string"},"provider_watchlist_name":{"description":"The name of the provider for this alert","type":"string"},"status":{"description":"The status of this alert","enum":["ACTIVE","SUPPRESSED"],"type":"string"},"urls":{"description":"Where to get more information about this alert (according to our third-party data provider).\n","items":{"type":"string"},"type":"array"},"vendor_info":{"$ref":"#/components/schemas/vendor_info"}},"required":["status"],"type":"object"},"watchlist_alert_list":{"allOf":[{"properties":{"alerts":{"items":{"$ref":"#/components/schemas/watchlist_alert"},"type":"array"}},"required":["alerts"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"watchlist_subscription":{"properties":{"auto_renew":{"description":"Whether this subscription should automatically renew when the subscription period is over (default: vendor-dependent).\n","type":"boolean"},"created":{"description":"When this subscription was created","format":"date-time","type":"string"},"customer_consent":{"description":"Whether this customer has consented to being enrolled for watchlist monitoring\n","type":"boolean"},"id":{"description":"Unique identifier for this subscription","format":"uuid","type":"string"},"period_end":{"description":"The date when monitoring of this individual should end.","format":"date","type":"string"},"period_start":{"description":"The date when monitoring of this individual should begin (default: today).","format":"date","type":"string"},"provider_subscription_id":{"description":"External provider subscription id","type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["customer_consent"],"type":"object"},"watchlist_subscription_list":{"allOf":[{"properties":{"subscriptions":{"items":{"$ref":"#/components/schemas/watchlist_subscription"},"type":"array"}},"required":["subscriptions"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"watchlist_suppress":{"properties":{"provider_subject_id":{"description":"The id of the subject (person) for whom future alerts should be suppressed.\n","type":"string"},"provider_subscription_id":{"description":"The provider's id for the subscription that caused the alert(s) that are being suppressed.\n","type":"string"},"status":{"description":"The status of this suppression","enum":["SUPPRESS","UNSUPPRESS"],"type":"string"}},"required":["provider_subscription_id","provider_subject_id","status"],"type":"object"},"webhook":{"description":"Webhook object","properties":{"description":{"description":"A description of what the webhook is used for","type":"string"},"enabled_events":{"description":"A list of the events that will trigger the webhook","items":{"$ref":"#/components/schemas/event_type1"},"type":"array"},"id":{"description":"The unique ID of the webhook","format":"uuid","readOnly":true,"type":"string"},"is_enabled":{"description":"Set the webhook to be enabled or disabled","type":"boolean"},"last_updated":{"description":"Timestamp that this webhook was created or the last time any field was changed","format":"date-time","readOnly":true,"type":"string"},"metadata":{"description":"Additional information stored to the webhook","maxLength":1024,"type":"string"},"url":{"description":"URL that the webhook will send request to","format":"uri","maxLength":1000,"type":"string"}},"required":["url","enabled_events","is_enabled"],"title":"Webhook","type":"object"},"webhook_config":{"properties":{"custom_header":{"$ref":"#/components/schemas/custom_headers"},"password":{"description":"password for access webhook endpoint","type":"string"},"url":{"description":"url of webhook endpoint","type":"string"},"username":{"description":"username for access webhook endpoint","type":"string"}},"type":"object"},"webhook_event":{"description":"name of the event","type":"string"},"webhook_list":{"allOf":[{"properties":{"webhooks":{"description":"Array of webhooks","items":{"$ref":"#/components/schemas/webhook"},"type":"array"}},"required":["webhooks"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}]},"webhook_request":{"properties":{"active":{"description":"indicates whether webhook is active","type":"boolean"},"config":{"$ref":"#/components/schemas/webhook_config"},"events":{"description":"list of webhook events, use * to receive all notifications","items":{"$ref":"#/components/schemas/webhook_event"},"type":"array"},"id":{"description":"id of the webhook","example":"e1dad623-98fa-48ee-8910-00a0b85ccbca","format":"uuid","type":"string"},"name":{"description":"name of the webhook","type":"string"}},"type":"object"},"webhook_response":{"allOf":[{"$ref":"#/components/schemas/webhook_request"},{"properties":{"creation_time":{"description":"The timestamp representing when the webhook request was made","example":"Fri Apr 01 2022 06:46:45 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"},"last_modified_time":{"description":"The timestamp representing when the webhook was last modified","example":"Thu Jul 14 2022 21:33:00 GMT+0000 (Coordinated Universal Time)","format":"date-time","readOnly":true,"type":"string"}},"type":"object"}]},"widget_type":{"description":"The widget type","enum":["set_pin","activate_card"],"type":"string"},"wire":{"properties":{"amount":{"description":"Transfer amount in cents ($100 would be 10000)","example":10000,"type":"integer"},"bank_message":{"description":"Instructions intended for the financial institutions that are processing the wire.","type":"string"},"creation_time":{"example":"2022-05-18TT17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"3-character currency code","example":"USD","type":"string"},"customer_id":{"description":"The customer UUID representing the person initiating the Wire transfer","example":"c6f0f83b-0b19-4eb3-b14d-233ef38af14a","format":"uuid","type":"string"},"id":{"description":"wire ID","format":"uuid","readOnly":true,"type":"string"},"last_updated_time":{"example":"2022-05-18TT17:54:12Z","format":"date-time","readOnly":true,"type":"string"},"originating_account_id":{"description":"Sender account ID","example":"9ea58e5e-b021-4a2c-bf91-9790cb3ac63e","format":"uuid","type":"string"},"receiving_account_id":{"description":"The external account uuid representing the recipient of the wire.","example":"0b320738-b9e8-4604-984b-6a83828e6163","format":"uuid","type":"string"},"recipient_message":{"description":"Information from the originator to the beneficiary (recipient).","type":"string"},"sender_reference_id":{"description":"Sender's id associated with fedwire transfer","example":"9F564A6124E65","readOnly":true,"type":"string"},"status":{"description":"The current status of the transfer","enum":["PENDING","COMPLETED","CANCELED","DECLINED"],"example":"PENDING","readOnly":true,"type":"string"},"transaction_id":{"description":"ID of the resulting transaction resource","format":"uuid","readOnly":true,"type":"string"}},"required":["id","transaction_id","amount","status","currency","customer_id","originating_account_id","receiving_account_id","sender_reference_id","creation_time","last_updated_time"],"title":"Wire","type":"object"},"wire_list":{"allOf":[{"properties":{"wires":{"description":"Array of wires","items":{"$ref":"#/components/schemas/wire"},"type":"array"}},"required":["wires"],"type":"object"},{"$ref":"#/components/schemas/paginated_response"}],"title":"Wire List"},"wire_request":{"properties":{"amount":{"description":"Transfer amount in cents ($100 would be 10000)","example":10000,"type":"integer"},"bank_message":{"description":"Instructions intended for the financial institutions that are processing the wire.","maxLength":210,"type":"string"},"currency":{"description":"3-character currency code","enum":["USD"],"example":"USD","type":"string"},"customer_id":{"description":"The customer UUID representing the person initiating the Wire transfer","example":"98f0e4c8-220b-463c-8981-7413c65ee6c9","format":"uuid","type":"string"},"metadata":{"description":"Additional transfer metadata structured as key-value pairs","type":"object"},"originating_account_id":{"description":"Sender account ID","example":"ed92890d-7111-465a-a972-1b6839e88eb2","format":"uuid","type":"string"},"receiving_account_id":{"description":"The external account uuid representing the recipient of the wire.","example":"72b70665-ba18-412e-a91f-cd59f72c6cd0","format":"uuid","type":"string"},"recipient_message":{"description":"Information from the originator to the beneficiary (recipient).","maxLength":140,"type":"string"}},"required":["customer_id","originating_account_id","receiving_account_id","amount","currency"],"title":"Wire payment request payload","type":"object"},"withdrawal_request_model":{"properties":{"account_type":{"enum":["checking","savings","credit"],"type":"string"},"amount":{"description":"The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)","type":"integer"},"card_acceptor":{"$ref":"#/components/schemas/card_acceptor_model"},"card_id":{"format":"uuid","type":"string"},"mid":{"maxLength":50,"minLength":1,"type":"string"},"pin":{"maxLength":15,"minLength":1,"type":"string"}},"required":["amount","card_id","mid"],"type":"object"},"workspace":{"properties":{"bank_id":{"description":"Bank ID","type":"integer"},"bank_name":{"description":"First Name","type":"string"},"environment":{"$ref":"#/components/schemas/environment"},"partner_id":{"description":"Partner ID","type":"integer"},"partner_name":{"description":"Last Name","type":"string"},"rank":{"description":"Each workspace has a rank. The highest-ranked (lowest numerical value) workspace is\nintended to be presented first within its environment.\n","type":"integer"},"verification_status":{"enum":["UNVERIFIED","PENDING","PROVISIONAL","ACCEPTED","REVIEW","REJECTED"],"type":"string"}},"required":["bank_id","partner_id","bank_name","partner_name","environment","verification_status","rank"],"title":"Workspace access for given user","type":"object"},"workspace_list":{"allOf":[{"properties":{"workspaces":{"description":"Array of Workspaces.","items":{"$ref":"#/components/schemas/workspace"},"type":"array"}},"required":["workspaces"],"type":"object"}]}},"securitySchemes":{"bearerAuth":{"bearerFormat":"api_key","scheme":"bearer","type":"http"}}},"info":{"description":"<h2>Let's build something great.</h2><p>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.</p><p>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, <a class='text-blue-600' href='https://synctera.com/contact' target='_blank' rel='noreferrer'>contact us</a>.</p>\n","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"title":"Synctera API","version":"0.20.0"},"openapi":"3.0.3","paths":{"/accounts":{"get":{"description":"Get paginated list of Accounts associated","operationId":"listAccounts","parameters":[{"$ref":"#/components/parameters/account_id_query"},{"$ref":"#/components/parameters/linked_account_id_query"},{"$ref":"#/components/parameters/overdraft_account_id_query"},{"$ref":"#/components/parameters/overflow_account_id_query"},{"$ref":"#/components/parameters/account_number"},{"$ref":"#/components/parameters/status"},{"$ref":"#/components/parameters/interest_product_id_query"},{"$ref":"#/components/parameters/customer_type"},{"$ref":"#/components/parameters/customer_id_query_one"},{"$ref":"#/components/parameters/business_id_query"},{"$ref":"#/components/parameters/person_id_query"},{"$ref":"#/components/parameters/first_name"},{"$ref":"#/components/parameters/last_name"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/account_sort_by_query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_list"}}},"description":"List of accounts"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List accounts","tags":["Accounts"],"x-external":true},"post":{"description":"Create a shadow mode or lead mode account. You need to determine the mode according to integrator configuration, and specify the required fields accordingly.\n\nShadow mode required fields:\n  - account_number\n  - status\n\nLead mode required fields:\n  - account_template_id\n  - relationships\n","operationId":"createAccount","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_creation"}}},"description":"Account to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_generic_response"}}},"description":"Created account"},"401":{"$ref":"#/components/responses/unauthorized"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"summary":"Create an account","tags":["Accounts"],"x-external":true},"summary":"Accounts"},"/accounts/{account_id}":{"get":{"description":"Get an account","operationId":"getAccount","parameters":[{"$ref":"#/components/parameters/account_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_generic_response"}}},"description":"Account"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Get account","tags":["Accounts"],"x-external":true},"patch":{"description":"Patch account.\n\nImmutable fields:\n  - account_number\n  - account_type\n  - account_template_id\n  - customer_type\n\nPlease note:\n  - Other fields cannot be modified when access_status is FROZEN.\n  - access_status has to be patched individually without other fields.\n","operationId":"patchAccount","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/account_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"Account fields to be patched","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_generic_response"}}},"description":"Updated account"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Patch account","tags":["Accounts"],"x-external":true},"put":{"description":"Update account\n\nShadow mode required fields:\n  - account_number\n  - status\n\nLead mode required fields:\n  - All fields are required.\n\nPlease note:\n  - access_status needs to be in ACTIVE.\n  - PUT request cannot change access_status.\n","operationId":"updateAccount","parameters":[{"$ref":"#/components/parameters/account_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"Account to update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_generic_response"}}},"description":"Updated account"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Update account","tags":["Accounts"],"x-external":true},"summary":"account"},"/accounts/{account_id}/relationships":{"get":{"description":"List all customers of an account","operationId":"listAccountRelationship","parameters":[{"$ref":"#/components/parameters/account_id_path"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship_list"}}},"description":"List of account relationships"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"List account relationships","tags":["Accounts"],"x-external":true},"post":{"description":"Add a customer to an account","operationId":"createAccountRelationship","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/account_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship"}}},"description":"Account relationship object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship"}}},"description":"Account relationship object"},"401":{"$ref":"#/components/responses/unauthorized"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Create account relationship","tags":["Accounts"],"x-external":true},"summary":"Account Relationship"},"/accounts/{account_id}/relationships/{relationship_id}":{"delete":{"description":"Delete account relationship","operationId":"DeleteAccountRelationship","parameters":[{"$ref":"#/components/parameters/account_id_path"},{"$ref":"#/components/parameters/relationship_id"}],"responses":{"200":{"$ref":"#/components/responses/delete_response"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Delete account relationship","tags":["Accounts"],"x-external":true},"get":{"description":"Get account relationship by ID","operationId":"getAccountRelationship","parameters":[{"$ref":"#/components/parameters/account_id_path"},{"$ref":"#/components/parameters/relationship_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship"}}},"description":"Account relationship"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Get account relationship","tags":["Accounts"],"x-external":true},"put":{"description":"Update account relationship. Only relationship_type can be updated. customer_id should not be modified.","operationId":"updateAccountRelationship","parameters":[{"$ref":"#/components/parameters/account_id_path"},{"$ref":"#/components/parameters/relationship_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship"}}},"description":"Account relationship to be updated","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship"}}},"description":"Updated account relationship"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Update account relationship","tags":["Accounts"],"x-external":true},"summary":"Account Relationship"},"/accounts/products":{"get":{"description":"List account Products\n","operationId":"listAccountResourceProducts","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"description":"Date range filtering for type INTEREST. All rates in interest resource have to have valid_from later or equal to start_date.","in":"query","name":"start_date","required":false,"schema":{"format":"date","type":"string"},"x-external":true},{"description":"Date range filtering for type INTEREST. All rates in interest resource have to have valid_to earlier or equal to end_date.","in":"query","name":"end_date","required":false,"schema":{"format":"date","type":"string"},"x-external":true},{"description":"Type of account product","in":"query","name":"product_type","required":true,"schema":{"enum":["FEE","INTEREST"],"type":"string"},"x-external":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_product_list"}}},"description":"List of account products"}},"summary":"List account products","tags":["Accounts"],"x-external":true},"post":{"description":"Create an account product. Rates cannot be nil or empty.\n","operationId":"createAccountResourceProduct","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_product"}}},"description":"Account product to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_product"}}},"description":"Account product created"}},"summary":"Create an account product","tags":["Accounts"],"x-external":true},"summary":"Account products"},"/accounts/products/{product_id}":{"patch":{"description":"Patch account product. Rates requires at minimum 1 entry if specified.\n","operationId":"patchAccountProduct","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/product_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_account_product"}}},"description":"Account product fields to be patched","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_product"}}},"description":"Updated account product"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Patch account product","tags":["Accounts"],"x-external":true},"summary":"Account products"},"/accounts/templates":{"get":{"description":"List account templates\n","operationId":"listAccountTemplates","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/template_list"}}},"description":"List of account templates"}},"summary":"List account templates","tags":["Accounts"],"x-external":true},"post":{"description":"Create an account template. An account template is need when create an account in a lead mode\n","operationId":"createAccountTemplate","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_template"}}},"description":"Account template to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_template_response"}}},"description":"Account template created"}},"summary":"Create an account template","tags":["Accounts"],"x-external":true},"summary":"Accounts"},"/accounts/templates/{template_id}":{"delete":{"description":"Delete account template","operationId":"DeleteAccountTemplate","parameters":[{"$ref":"#/components/parameters/template_id"}],"responses":{"200":{"$ref":"#/components/responses/delete_response"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Delete account template","tags":["Accounts"],"x-external":true},"get":{"description":"Get an account template","operationId":"getAccountTemplate","parameters":[{"$ref":"#/components/parameters/template_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_template_response"}}},"description":"Account Template"}},"summary":"Get account template","tags":["Accounts"],"x-external":true},"put":{"description":"Update account template\n","operationId":"updateAccountTemplate","parameters":[{"$ref":"#/components/parameters/template_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_template"}}},"description":"Account template to update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_template_response"}}},"description":"Account template updated"}},"summary":"Update account template","tags":["Accounts"],"x-external":true},"summary":"account"},"/ach":{"description":"The ACH object represents your sent ACH.\n","get":{"description":"List sent ACH transactions","operationId":"listTransactionsOut","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/outgoing_ach_list"}}},"description":"List of sent ACH transactions."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List sent ACH transactions","tags":["ACH"],"x-external":true},"post":{"description":"Send an ACH\n","operationId":"addTransactionOut","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/outgoing_ach_request"}}},"description":"Send ACH request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/outgoing_ach"}}},"description":"Sent ACH response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Send an ACH","tags":["ACH"],"x-external":true},"summary":"Sent ACH"},"/ach/{transaction_id}":{"get":{"description":"Get a single sent ACH transaction","operationId":"getTransactionOut","parameters":[{"$ref":"#/components/parameters/transaction_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/outgoing_ach"}}},"description":"Sent ACH transaction representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a sent ACH transaction","tags":["ACH"],"x-external":true},"patch":{"description":"Update a sent ACH transaction (either status or funds availability)","operationId":"patchTransactionOut","parameters":[{"$ref":"#/components/parameters/transaction_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/outgoing_ach_patch"}}},"description":"Update sent ach transaction","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/outgoing_ach"}}},"description":"Sent ACH transaction representation."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a sent ACH transaction","tags":["ACH"],"x-external":true},"summary":"Sent ACH detail"},"/applications":{"get":{"description":"List credit applications.\n","operationId":"listApplications","parameters":[{"$ref":"#/components/parameters/customer_id_query_array"},{"$ref":"#/components/parameters/application_status"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_list"}}},"description":"List of credit applications"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List credit applications.","tags":["Applications"],"x-external":true},"post":{"description":"Create a credit application.\n","operationId":"createApplication","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}},"description":"Submit application details for a credit account","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_response"}}},"description":"Credit application created."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a credit application.","tags":["Applications"],"x-external":true},"summary":"Applications"},"/applications/{application_id}":{"get":{"description":"Get application by ID.\n","operationId":"getApplication","parameters":[{"$ref":"#/components/parameters/application_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_response"}}},"description":"Application representation"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Application","tags":["Applications"],"x-external":true},"patch":{"description":"Patch Application.\n","operationId":"patchApplication","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/application_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_patch"}}},"description":"Application fields to be patched","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_response"}}},"description":"Updated application"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Patch Application","tags":["Applications"],"x-external":true},"summary":"Application"},"/businesses":{"get":{"description":"Retrieves paginated list of businesses associated with the authorized requester.","operationId":"listBusinesses","parameters":[{"$ref":"#/components/parameters/id_query"},{"$ref":"#/components/parameters/entity_name"},{"$ref":"#/components/parameters/phone_number"},{"$ref":"#/components/parameters/status1"},{"$ref":"#/components/parameters/is_customer"},{"$ref":"#/components/parameters/business_sort_by_query"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business_list"}}},"description":"List of businesses."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List business","tags":["Businesses"],"x-external":true,"x-status":"alpha"},"post":{"description":"Create a business who may act as a customer or a related business. You can then verify the identity of this customer and associate them with other people and accounts.\n","operationId":"createBusiness","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business"}}},"description":"The created business."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a business","tags":["Businesses"],"x-external":true,"x-status":"alpha"},"summary":"Businesses"},"/businesses/{business_id}":{"get":{"description":"Get business by ID.","operationId":"getBusiness","parameters":[{"$ref":"#/components/parameters/business_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business"}}},"description":"Business representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get business","tags":["Businesses"],"x-external":true,"x-status":"alpha"},"patch":{"description":"Update business by ID.","operationId":"updateBusiness","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/business_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_business"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business"}}},"description":"Updated business representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Patch business","tags":["Businesses"],"x-external":true,"x-status":"alpha"}},"/cards":{"description":"The Card object represents your customer's spending card.\n","get":{"description":"List of cards matching query parameters\n","operationId":"listCards","parameters":[{"$ref":"#/components/parameters/customer_id_query"},{"$ref":"#/components/parameters/account_id_query_array"},{"$ref":"#/components/parameters/emboss_name_query"},{"$ref":"#/components/parameters/last_four_query"},{"$ref":"#/components/parameters/expiration_date_query"},{"$ref":"#/components/parameters/card_type_query"},{"$ref":"#/components/parameters/card_brand_query"},{"$ref":"#/components/parameters/form_query"},{"$ref":"#/components/parameters/card_product_id_query"},{"$ref":"#/components/parameters/card_status_query"},{"$ref":"#/components/parameters/postal_code_query"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/card_sort_by_query"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_list_response"}}},"description":"Cards"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Cards","tags":["Cards"],"x-external":true},"post":{"description":"Issue or reissue a new card for a customer\n","operationId":"issueCard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_issuance_request"}}},"description":"Card to issue","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_response"}}},"description":"Card issued"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Issue a Card","tags":["Cards"],"x-external":true},"summary":"Cards"},"/cards/{card_id}":{"description":"The Card object represents your customer's spending card.\n","get":{"description":"Get the details about a card that has been issued\n","operationId":"getCard","parameters":[{"$ref":"#/components/parameters/card_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_response"}}},"description":"Card details"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Card","tags":["Cards"],"x-external":true},"patch":{"description":"Integrators can update the card resource to change status, update shipping (if the card hasn't been shipped) or edit metadata.\n","operationId":"updateCard","parameters":[{"$ref":"#/components/parameters/card_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_edit_request"}}},"description":"Card edits","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_response"}}},"description":"Card issued"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update Card","tags":["Cards"],"x-external":true},"summary":"Cards"},"/cards/{card_id}/barcodes":{"get":{"description":"This endpoint is for testing environment only to provide access to barcode of a test card\n","operationId":"getCardBarcode","parameters":[{"$ref":"#/components/parameters/card_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"barcode":{"description":"Barcode of the card","type":"string"}},"type":"object"}}},"description":"Barcode"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Card Barcode","tags":["Cards"],"x-external":true},"summary":"Cards"},"/cards/{card_id}/changes":{"get":{"description":"List card change history\n","operationId":"listChanges","parameters":[{"$ref":"#/components/parameters/card_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_changes_list"}}},"description":"List of card changes"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Card Changes","tags":["Cards"],"x-external":true}},"/cards/{card_id}/client_token":{"description":"Client access token for accessing privileged details about a card\n","post":{"description":"Create a client access token for interacting with a card.  This token will be used on the client to identify the card for flows like viewing Full PAN or setting the PIN in a PCI compliant manner.\n","operationId":"getClientAccessToken","parameters":[{"$ref":"#/components/parameters/card_id"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_token"}}},"description":"Client token"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a client token","tags":["Cards"],"x-external":true},"summary":"Get Client Access Token"},"/cards/{card_id}/digital_wallet_tokens/applepay":{"post":{"operationId":"createDigitalWalletApple","parameters":[{"$ref":"#/components/parameters/card_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apple_digital_wallet_provision_request"}}},"description":"Request to provision digital wallet card data to pass to Apple Pay digital wallet","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apple_digital_wallet_provision_response"}}},"description":"Digital wallet token provision request data"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create digital wallet token provision request for Apple Pay","tags":["Digital Wallet Tokens"],"x-external":true}},"/cards/{card_id}/digital_wallet_tokens/googlepay":{"post":{"operationId":"createDigitalWalletGoogle","parameters":[{"$ref":"#/components/parameters/card_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/google_digital_wallet_provision_request"}}},"description":"Request to provision digital wallet card data to pass to Google Pay digital wallet","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/google_digital_wallet_provision_response"}}},"description":"Digital wallet token provision request data"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create digital wallet token provision request for Google Pay","tags":["Digital Wallet Tokens"],"x-external":true}},"/cards/{card_id}/webhook_simulations/fulfillment":{"description":"Simulate card fulfillment event\n","post":{"description":"This endpoint is for testing environment only to trigger a simulated change in card fulfillment status event\n","operationId":"simulateCardFulfillmentEvent","parameters":[{"$ref":"#/components/parameters/card_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulate_card_fulfillment"}}},"description":"Desired simulated fulfillment status change value","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulate_card_fulfillment"}}},"description":"Simulated fulfillment status change value"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate Card Fulfillment Event","tags":["Card Webhook Simulations"],"x-external":true},"summary":"Card Webhook Simulations"},"/cards/activate":{"description":"Activate a card\n","post":{"description":"Activate a card\n","operationId":"activateCard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_activation_request"}}},"description":"Card activation code","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_response"}}},"description":"Card activated successfully"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Activate a card","tags":["Cards"],"x-external":true},"summary":"Card Activation"},"/cards/card_widget_url":{"get":{"description":"This endpoint returns a URL address of the specified widget for a given card\n","operationId":"getCardWidgetURL","parameters":[{"description":"The type of widget for which to construct the URL","in":"query","name":"widget_type","required":true,"schema":{"$ref":"#/components/schemas/widget_type"},"x-external":true},{"in":"query","name":"customer_id","required":true,"schema":{"$ref":"#/components/schemas/customer_id1"},"x-external":true},{"in":"query","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/account_id"},"x-external":true},{"description":"The ID of the card (required for set PIN widget)","in":"query","name":"card_id","schema":{"$ref":"#/components/schemas/card_id"},"x-external":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_widget_url_response"}}},"description":"Card issued"},"default":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error"}},"summary":"Get card widget URL","tags":["Cards"],"x-external":true},"summary":"Get Card Widget URL"},"/cards/digital_wallet_tokens":{"get":{"description":"List Digital Wallet Tokens\n","operationId":"listDigitalWalletTokens","parameters":[{"$ref":"#/components/parameters/card_id_query"},{"$ref":"#/components/parameters/digital_wallet_token_state_query"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/token_list_response"}}},"description":"List of Digital Wallet Tokens of a card"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Digital Wallet Tokens","tags":["Digital Wallet Tokens"],"x-external":true}},"/cards/digital_wallet_tokens/{digital_wallet_token_id}":{"description":"The Digital Wallet token object represents your card's digital wallet token(s).\n","get":{"description":"Get the details about the digital wallet token of a card\n","operationId":"getDigitalWalletToken","parameters":[{"$ref":"#/components/parameters/digital_wallet_token_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital_wallet_token_response"}}},"description":"Digital Wallet Token details"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Digital Wallet Token","tags":["Digital Wallet Tokens"],"x-external":true},"patch":{"description":"The status of a digital wallet token can be updated as, ACTIVE to SUSPENDED, SUSPENDED to ACTIVE, ACTIVE to TERMINATED or SUSPENDED to TERMINATED.\n","operationId":"updateDigitalWalletTokenStatus","parameters":[{"$ref":"#/components/parameters/digital_wallet_token_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital_wallet_token_edit_request"}}},"description":"Update Digital wallet token status","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital_wallet_token_response"}}},"description":"Digital wallet token Status updated"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update Digital Wallet Token's life cycle status","tags":["Digital Wallet Tokens"],"x-external":true},"summary":"Digital Wallet Token"},"/cards/gateways":{"description":"The Gateway object represents the Authorization gateway configuration.\n","get":{"description":"List of gateways matching query parameters\n","operationId":"listGateways","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_list_response"}}},"description":"Gateways"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Gateways","tags":["Cards"],"x-external":true},"post":{"description":"Create a new Authorization Gateway Configuration\n","operationId":"createGateway","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_gateway_request"}}},"description":"Create a new Authorization Gateway Configuration","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_response"}}},"description":"New Authorization Gateway Configuration created"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create Gateway","tags":["Cards"],"x-external":true},"summary":"Authorization Gateway Configuration"},"/cards/gateways/{gateway_id}":{"description":"The Gateway object represents the Authorization gateway configuration.\n","get":{"description":"Get the details of an Authorization Gateway that has been configured\n","operationId":"getGateway","parameters":[{"$ref":"#/components/parameters/gateway_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_response"}}},"description":"Gateway details"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Gateway","tags":["Cards"],"x-external":true},"patch":{"description":"Update Authorization Gateway configuration\n","operationId":"updateGateway","parameters":[{"$ref":"#/components/parameters/gateway_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_gateway_request"}}},"description":"Gateway edits","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_response"}}},"description":"Gateway Updated"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update Gateway","tags":["Cards"],"x-external":true},"summary":"Authorization Gateway"},"/cards/images":{"get":{"description":"List all card image details\n","operationId":"listCardImageDetails","parameters":[{"$ref":"#/components/parameters/customer_id_query_required"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_image_details_list"}}},"description":"List of details for images uploaded by the given customer"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Card Image Details","tags":["Cards"],"x-external":true},"post":{"description":"Create a card image entity. Note that this does not include the image data itself. You can upload the image data via a subsequent uploadCardImageData request using the ID created here.\n","operationId":"createCardImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_card_image_request"}}},"description":"Details of the image to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_image_details"}}},"description":"Card image entity created"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create Card Image","tags":["Cards"],"x-external":true}},"/cards/images/{card_image_id}":{"get":{"description":"Get card image details","operationId":"getCardImageDetails","parameters":[{"$ref":"#/components/parameters/card_image_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_image_details"}}},"description":"Details of the card image"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Card Image Details","tags":["Cards"],"x-external":true},"patch":{"description":"Update card image details. The only detail that can be updated is the card status as APPROVED or REJECTED.","operationId":"updateCardImageDetails","parameters":[{"$ref":"#/components/parameters/card_image_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_card_image_request"}}},"description":"Details of the image to create","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_image_details"}}},"description":"Details of the card image"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update Card Image Details","tags":["Cards"],"x-external":true}},"/cards/images/{card_image_id}/data":{"get":{"description":"Get card image data","operationId":"getCardImageData","parameters":[{"$ref":"#/components/parameters/card_image_id"}],"responses":{"200":{"content":{"image/jpeg":{"schema":{"format":"binary","type":"string"}}},"description":"Image data"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Card Image Data","tags":["Cards"],"x-external":true},"post":{"description":"Upload card image data","operationId":"uploadCardImageData","parameters":[{"$ref":"#/components/parameters/card_image_id"}],"requestBody":{"content":{"image/jpeg":{"schema":{"format":"binary","type":"string"}}},"description":"Binary image data","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_image_details"}}},"description":"Card image data was successfully uploaded"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upload Card Image","tags":["Cards"],"x-external":true}},"/cards/products":{"get":{"operationId":"listCardProducts","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card_product_list_response"}}},"description":"List of available Card Products"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Card Products","tags":["Cards"],"x-external":true}},"/cards/single_use_token":{"post":{"description":"This endpoint returns a single-use access token. This type of token authorizes a single request to access API endpoints and data associated with a particular user\n","operationId":"getClientSingleUseToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_use_token_request"}}},"description":"User token details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_use_token_response"}}},"description":"Token Created"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get single-use token","tags":["Cards"],"x-external":true},"summary":"Get Single-Use Token"},"/cards/transaction_simulations/authorization":{"post":{"description":"Simulate an `authorization` type transaction by including the `card_token` and other authorization details in your request.\n","operationId":"simulateAuthorization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/auth_request_model"}}},"description":"Authorization details","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate authorization","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate Authorization"},"/cards/transaction_simulations/authorization/advice":{"post":{"description":"An authorization advice allows an amount to be decreased after the authorization. This endpoint allows you to simulate post-swipe adjustments.\n\nSimulate an `authorization.advice` type transaction by including the `original_transaction_token` and other authorization details in your request.\n","operationId":"simulateAuthorizationAdvice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorization_advice_model"}}},"description":"Authorization advice details","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate authorization advice","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate Authorization Advice"},"/cards/transaction_simulations/clearing":{"post":{"description":"Simulate an `authorization.clearing` type transaction by including the `original_transaction_token` and `amount` in your request. To simulate a refund type transaction, set the `is_refund` field to true.\n","operationId":"simulateClearing","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clearing_model"}}},"description":"Transaction clearing or refund details","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate clearing or refund","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate Clearing or Refund"},"/cards/transaction_simulations/financial":{"post":{"description":"A \"financial\" is a transaction message class that includes ATM transactions, PIN-debit transactions, and balance inquiries.\n\nSimulate a `pindebit` type transaction by including the `card_token` and `amount` in your request.\n","operationId":"simulateFinancial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/financial_request_model"}}},"description":"Financial details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate financial","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate Financial"},"/cards/transaction_simulations/financial/advice":{"post":{"description":"Simulate a financial advice by including the `original_transaction_token` and other authorization details in JSON format in the body of the request.\n","operationId":"simulateFinancialAdvice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorization_advice_model"}}},"description":"Financial advice details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate financial advice","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate Financial Advice"},"/cards/transaction_simulations/financial/balance_inquiry":{"post":{"description":"Simulate a `pindebit.balanceinquiry` type transaction by sending a POST request to the `/simulate/financial/balanceinquiry` endpoint.\n","operationId":"simulateBalanceInquiry","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/balance_inquiry_request_model"}}},"description":"Balance inquiry details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate balance inquiry","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate Balance Inquiry"},"/cards/transaction_simulations/financial/original_credit":{"post":{"description":"This Original Credit Transaction (OCT) enables the cardholder to receive funds on the specified card from an external source via the card network. Use this endpoint to simulate a transaction that is similar to a wire transfer and not linked to any purchase.\n\nSimulate an OCT by including the `card_token`, `amount`, `mid`, and `type` in your request.\n","operationId":"simulateOriginalCredit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/original_credit_request_model"}}},"description":"OCT details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate OCT","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate OCT"},"/cards/transaction_simulations/financial/withdrawal":{"post":{"description":"Simulate a `pindebit.atm.withdrawal` type transaction by including the `card_token` and `amount` in your request.\n","operationId":"simulateWithdrawal","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/withdrawal_request_model"}}},"description":"ATM withdrawal details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate ATM withdrawal","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate ATM Withdrawal"},"/cards/transaction_simulations/reversal":{"post":{"description":"A reversal releases the hold that was placed on account funds by an authorization, thus returning the funds to the account.\n\nSimulate an `authorization.reversal` type transaction by including the `original_transaction_token` and `amount` in your request.\n","operationId":"simulateReversal","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reversal_model"}}},"description":"Reversal details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/simulation_response_model"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Simulate reversal","tags":["Card Transaction Simulations"],"x-external":true},"summary":"Simulate Reversal"},"/customers":{"description":"The Customer object represents your customer's identity.  You can then verify the identity of this customer and associate them with other people and accounts\n","get":{"description":"Retrieves paginated list of Customers associated with the authorized requester","operationId":"listCustomers","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/first_name"},{"$ref":"#/components/parameters/last_name"},{"$ref":"#/components/parameters/phone_number"},{"$ref":"#/components/parameters/email"},{"$ref":"#/components/parameters/ssn_last_4"},{"$ref":"#/components/parameters/status2"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/customer_sort_by_query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_list"}}},"description":"List of customers"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Customers","tags":["Customers"],"x-external":true},"post":{"description":"The customer object represents your customer's identity. You can then verify the identity of this customer and associate them with other people and accounts.\nNote that if no shipping_address attribute is provided in the request, the shipping_address will be set to a copy of the legal_address.\n","operationId":"createCustomer","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_in_body"}}},"description":"Customer to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_in_body"}}},"description":"Created customer"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a Customer","tags":["Customers"],"x-external":true},"summary":"Customer"},"/customers/{customer_id}":{"description":"This resource represents a customer.  Each customer is identified by a customer `ID`\n","get":{"description":"Get Customer based on ID","operationId":"getCustomer","parameters":[{"$ref":"#/components/parameters/customer_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_in_body"}}},"description":"Customer"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Customer","tags":["Customers"],"x-external":true},"patch":{"description":"Patch fields of customer based on ID\nNote that if:\n  * legal address is provided in the request, AND\n  * shipping_address is not provided in the request, AND\n  * the customer resource does not have shipping_address\n  then shipping_address will be set to a copy of the legal_address.\n","operationId":"patchCustomer","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_customer"}}},"description":"Customer to be patched","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_in_body"}}},"description":"Patched customer"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Patch Customer","tags":["Customers"],"x-external":true},"put":{"description":"Update customer based on ID\nNote that if no shipping_address attribute is provided in the request, the shipping_address will be set to a copy of the legal_address.\n","operationId":"updateCustomer","parameters":[{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_in_body"}}},"description":"Customer to be updated","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_in_body"}}},"description":"Updated customer"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update Customer","tags":["Customers"],"x-external":true},"summary":"Customer"},"/customers/{customer_id}/disclosures":{"description":"Disclosures to be made to customers\n","get":{"deprecated":true,"description":"Retrieves paginated list of disclosures associated with the authorized requester","operationId":"listDisclosures1","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclosure_response"}}},"description":"List of disclosures"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Disclosures","tags":["Disclosures"],"x-external":true,"x-status":"deprecated"},"post":{"deprecated":true,"description":"Disclosures to be made to customers\n","operationId":"createDisclosure1","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclosure1"}}},"description":"Disclosure to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclosure1"}}},"description":"Created disclosure"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a Disclosure","tags":["Disclosures"],"x-external":true,"x-status":"deprecated"},"summary":"Disclosures"},"/customers/{customer_id}/employment":{"get":{"description":"Get a list of customer's current employment records. To see historic employment pass the `include_history` flag.\n","operationId":"getAllCustomerEmployment","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/include_history"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/employment_list"}}},"description":"List of customer employment records."},"400":{"$ref":"#/components/responses/bad_request"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List customer employment records","tags":["Customers"],"x-external":true},"post":{"description":"Create a customer employment record.","operationId":"createCustomerEmployment","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/employment"}}},"description":"Customer employment record to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/employment"}}},"description":"Created customer employment record."},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create employment record","tags":["Customers"],"x-external":true},"summary":"Customer employment group operations"},"/customers/{customer_id}/employment/{employment_id}":{"get":{"description":"Get a single record of customer employment","operationId":"getPartyEmployment","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/employment_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/employment"}}},"description":"Customer employment record."},"400":{"$ref":"#/components/responses/bad_request"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get customer employment record","tags":["Customers"],"x-external":true},"put":{"description":"Update a single record of customer employment.","operationId":"updatePartyEmployment","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/employment_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/employment"}}},"description":"Customer employment to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/employment"}}},"description":"Updated customer employment record"},"400":{"$ref":"#/components/responses/bad_request"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update customer employment record","tags":["Customers"],"x-external":true},"summary":"Customer employment operations"},"/customers/{customer_id}/prefill":{"post":{"description":"Prefill takes a subset of a person's information and automatically fills personally identifiable information (PII) required for know your customer (KYC) verification.\n","operationId":"prefillCustomer","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/prefill_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/prefill_request"}}},"description":"Prefill response."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Prefill customer","tags":["Customers"],"x-external":true,"x-status":"alpha"}},"/customers/{customer_id}/risk_ratings":{"get":{"description":"Get list of customer risk ratings","operationId":"getAllCustomerRiskRatings","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/include_history"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/risk_rating_list"}}},"description":"List of customer risk ratings"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List customer risk ratings","tags":["Customers"],"x-external":true},"post":{"description":"Create customer risk rating","operationId":"createCustomerRiskRating","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/risk_rating"}}},"description":"Create a customer risk rating. With a risk rating in request body, Synctera\nvalidates the data and saves it. With no request body, Synctera runs an\nautomated risk analysis and saves the result.\n","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/risk_rating"}}},"description":"Created risk rating"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create customer risk rating","tags":["Customers"],"x-external":true},"summary":"Risk Rating group operations"},"/customers/{customer_id}/risk_ratings/{risk_rating_id}":{"get":{"description":"Get a customer risk rating","operationId":"getCustomerRiskRating","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/risk_rating_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/risk_rating"}}},"description":"Customer risk rating of id"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get customer risk rating","tags":["Customers"],"x-external":true},"summary":"Risk Rating"},"/customers/{customer_id}/verifications":{"get":{"deprecated":true,"description":"List verification results.\n\nThis endpoint will be removed in API v1. Use `GET /v0/verifications?customer_id={customer_id}` instead.\n","operationId":"listVerifications","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/include_history"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_verification_result_list"}}},"description":"List of customer verification results."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List verification results","tags":["KYC Verification"],"x-external":true,"x-status":"deprecated"},"post":{"deprecated":true,"description":"Create a verification result for a customer.\nThis endpoint will be removed in API v1. Use `POST /v0/verifications` instead.\n","operationId":"createCustomerVerificationResult","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_verification_result"}}},"description":"Customer verification result to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_verification_result"}}},"description":"Created customer verification result."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a customer verification result","tags":["KYC Verification"],"x-external":true,"x-status":"deprecated"}},"/customers/{customer_id}/verifications/{verification_id}":{"get":{"deprecated":true,"description":"Get verification result by ID.\n\nThis endpoint will be removed in API v1. Use `GET /v0/verifications/{verification_id}` instead.\n","operationId":"getVerification","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/verification_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_verification_result"}}},"description":"Verification result."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get verification result","tags":["KYC Verification"],"x-external":true,"x-status":"deprecated"}},"/customers/{customer_id}/verify":{"post":{"deprecated":true,"description":"Initiate identity verification for a customer and run the specified identity checks.\n\nVerifying a personal customer requires that the following fields already be set:\n* `first_name`\n* `last_name`\n* `dob`\n* `email`\n* `phone_number`\n* `legal_address`\n* `ssn`\n\nThis endpoint will be removed in API v1. Use `POST /v0/verifications/verify` instead.\n","operationId":"verifyCustomer","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_verification"}}},"description":"Customer verification request.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_verify_response"}}},"description":"Customer verification result."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Verify a customer's identity","tags":["KYC Verification"],"x-external":true,"x-status":"deprecated"}},"/customers/{customer_id}/watchlists/alerts":{"description":"List, retrieve, or update watchlist alerts. **Deprecated:** use `/v0/monitoring/alerts`.\n","get":{"deprecated":true,"operationId":"listWatchlistAlerts","parameters":[{"$ref":"#/components/parameters/customer_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_alert_list"}}},"description":"List of watchlist alerts"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List watchlist monitoring alerts for a customer","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"summary":"Subscriptions to watchlist alerts"},"/customers/{customer_id}/watchlists/alerts/{alert_id}":{"description":"Retrieve or update a single watchlist alert. **Deprecated:** use `/v0/monitoring/alerts/{alert_id}` instead.\n","get":{"deprecated":true,"operationId":"getWatchlistAlert","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/alert_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_alert"}}},"description":"A single watchlist alert"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Retrieve watchlist monitoring alert","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"put":{"deprecated":true,"operationId":"updateWatchlistAlert","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/alert_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_alert"}}},"description":"A watchlist body","required":true},"responses":{"200":{"description":"Watchlist alert was updated"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update watchlist alert","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"summary":"Retrieve or update a single watchlist alert."},"/customers/{customer_id}/watchlists/subscriptions":{"description":"Create, list, or retrieve watchlist subscriptions **Deprecated:** use `/v0/monitoring/subscriptions`\n","get":{"deprecated":true,"operationId":"listWatchlistSubscriptions","parameters":[{"$ref":"#/components/parameters/customer_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_subscription_list"}}},"description":"List of watchlist subscriptions"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List watchlist monitoring subscriptions for a customer","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"post":{"deprecated":true,"operationId":"watchlistSubscribe","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_subscription"}}},"description":"A watchlist subscription","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_subscription"}}},"description":"New watchlist subscription"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Subscribe a customer to watchlist monitoring","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"summary":"Subscriptions to watchlist monitoring"},"/customers/{customer_id}/watchlists/subscriptions/{subscription_id}":{"description":"Retrieve or update a single watchlist subscription **Deprecated:** use `/v0/monitoring/subscriptions/{subscription_id}`.\n","get":{"deprecated":true,"operationId":"getWatchlistSubscription","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/subscription_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_subscription"}}},"description":"A single watchlist subscription"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Retrieve watchlist monitoring subscription","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"put":{"deprecated":true,"operationId":"updateWatchlistSubscription","parameters":[{"$ref":"#/components/parameters/customer_id_path"},{"$ref":"#/components/parameters/subscription_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_subscription"}}},"description":"Watchlist monitoring subscription to be updated. The only field that matters is `status`; all other fields are ignored.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_subscription"}}},"description":"Updated watchlist subscription"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update watchlist monitoring subscription","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"summary":"Watchlist monitoring subscription"},"/customers/{customer_id}/watchlists/suppressions":{"description":"Suppress or unsuppress current and future alerts for the given subject (person).\n","post":{"deprecated":true,"operationId":"suppressWatchlistEntityAlert","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/customer_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watchlist_suppress"}}},"description":"A watchlist suppression object","required":true},"responses":{"200":{"description":"Watchlist alerts belonging to entity was updated"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Suppress entity alert","tags":["Watchlist"],"x-external":true,"x-status":"deprecated"},"summary":"Update suppression of watchlist alerts for one subject"},"/disclosures":{"get":{"description":"Retrieves paginated list of disclosures associated with the authorized requester.","operationId":"listDisclosures","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/person_id_query"},{"$ref":"#/components/parameters/business_id_query"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclosure_list"}}},"description":"List of disclosures."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List disclosures","tags":["Disclosures"],"x-external":true,"x-status":"alpha"},"post":{"description":"Record the fact that a regulatory document was disclosed to a customer.","operationId":"createDisclosure","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclosure"}}},"description":"Disclosure to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclosure"}}},"description":"Created disclosure."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create disclosure record","tags":["Disclosures"],"x-external":true,"x-status":"alpha"}},"/disclosures/{disclosure_id}":{"get":{"description":"Get disclosure by ID.","operationId":"getDisclosure","parameters":[{"$ref":"#/components/parameters/disclosure_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disclosure"}}},"description":"Disclosure representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get disclosure","tags":["Disclosures"],"x-external":true,"x-status":"alpha"}},"/documents":{"get":{"description":"Returns a paginated list of documents.","operationId":"listDocuments","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_list"}}},"description":"List documents."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List documents","tags":["Documents (alpha)"],"x-external":true,"x-status":"alpha"},"post":{"description":"Docs\n","operationId":"createDocument","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/document_creation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document"}}},"description":"Created document representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a document","tags":["Documents (alpha)"],"x-external":true,"x-status":"alpha"},"summary":"Documents"},"/documents/{document_id}":{"get":{"description":"Returns the bytes of the requested document.","operationId":"getDocument","parameters":[{"$ref":"#/components/parameters/document_id"}],"responses":{"200":{"content":{"*/*":{"schema":{"format":"binary","type":"string"}}},"description":"The requested document."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a document","tags":["Documents (alpha)"],"x-external":true,"x-status":"alpha"},"patch":{"description":"Update document attributes by document ID","operationId":"updateDocument","parameters":[{"$ref":"#/components/parameters/document_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_document"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document"}}},"description":"Updated document properties."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a document","tags":["Documents (alpha)"],"x-external":true,"x-status":"alpha"},"summary":"Document"},"/documents/{document_id}/contents":{"get":{"description":"Returns the bytes of the requested document.","operationId":"getDocumentContents","parameters":[{"$ref":"#/components/parameters/document_id"}],"responses":{"200":{"content":{"*/*":{"schema":{"format":"binary","type":"string"}}},"description":"The requested document."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a document","tags":["Documents (alpha)"],"x-external":true,"x-status":"alpha"},"summary":"Document"},"/external_accounts":{"description":"The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem.\n","get":{"description":"Returns a list of all external accounts assigned to customers.\n","operationId":"listExternalAccounts","parameters":[{"$ref":"#/components/parameters/customer_id_query_array"},{"$ref":"#/components/parameters/business_id_query_array"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts_list"}}},"description":"List of external accounts"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List external accounts","tags":["External Accounts"],"x-external":true},"post":{"description":"Add an external account for a customer. The account will be created in an unverified state.\n","operationId":"addExternalAccounts","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_accounts_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}},"description":"The external account added."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Add an external account","tags":["External Accounts"],"x-external":true},"summary":"External Accounts"},"/external_accounts/{external_account_id}":{"delete":{"description":"Deletes an external account, given an external account ID. If no accounts left, the access token to the financial institution will be removed\n","operationId":"deleteExternalAccount","parameters":[{"$ref":"#/components/parameters/external_account_id"}],"responses":{"200":{"$ref":"#/components/responses/delete_response"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/already_exists"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete an external account","tags":["External Accounts"],"x-external":true},"description":"The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem.\n","get":{"description":"Returns an external account, given an external account ID.\n","operationId":"getExternalAccount","parameters":[{"$ref":"#/components/parameters/external_account_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}},"description":"The external account"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get an external account","tags":["External Accounts"],"x-external":true},"patch":{"description":"Edits an unverified external account, given an external account ID.\n","operationId":"updateExternalAccount","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/external_account_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_external_account"}}},"description":"External account to be updated","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}},"description":"Updated external account"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/already_exists"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Patch an external account","tags":["External Accounts"],"x-external":true},"summary":"External Accounts"},"/external_accounts/{external_account_id}/balance":{"description":"The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem.\n","get":{"description":"Returns an external account balance, given an external account ID.\n","operationId":"getExternalAccountBalance","parameters":[{"$ref":"#/components/parameters/external_account_id"},{"$ref":"#/components/parameters/max_age"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account_balance"}}},"description":"The external account"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get an external account balance","tags":["External Accounts"],"x-external":true},"summary":"External Accounts"},"/external_accounts/{external_account_id}/transactions":{"description":"The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem.\n","get":{"description":"Returns a list of transactions on from the external account, given an external account ID. Maximum 500 transctions will be returned.\n","operationId":"getExternalAccountTransactions","parameters":[{"$ref":"#/components/parameters/external_account_id"},{"description":"Date range filtering for transactions. Date is inclusive. Date must be in UTC.","in":"query","name":"start_date","required":true,"schema":{"format":"date","type":"string"},"x-external":true},{"description":"Date range filtering for transactions. Date is exclusive. Date must be in UTC.","in":"query","name":"end_date","required":true,"schema":{"format":"date","type":"string"},"x-external":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts_transaction_list"}}},"description":"The external account"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List transactions of a given external account","tags":["External Accounts"],"x-external":true},"summary":"External Accounts"},"/external_accounts/access_tokens":{"description":"Create a permanent access token for an external account\n","post":{"operationId":"createAccessToken","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account_access_token"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account_access_token"}}},"description":"New verification link token"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a permanent access token for an external account","tags":["External Accounts"],"x-external":true},"summary":"External account access token"},"/external_accounts/add_vendor_accounts":{"description":"The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem.\n","post":{"description":"Add external accounts for a customer through an existing access token. The token must be valid, and the information on the accounts returned by the vendor must correspond to the customer. A success response for this route may include failures if an account could not be added, so it's important that the caller checks the response body.\n","operationId":"addVendorExternalAccounts","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_vendor_accounts_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_vendor_accounts_response"}}},"description":"Result of adding accounts through the vendor.\n"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Add external accounts through a vendor, such as Plaid.","tags":["External Accounts"],"x-external":true},"summary":"External Accounts"},"/external_accounts/link_tokens":{"description":"Create a link token to verify an external account\n","post":{"operationId":"createVerificationLinkToken","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account_link_token"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account_link_token"}}},"description":"New verification link token"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a link token to verify an external account","tags":["External Accounts"],"x-external":true},"summary":"External account verification link token"},"/external_accounts/sync_vendor_accounts":{"description":"The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem.\n","post":{"description":"Sync external accounts for a customer through an existing access token. The token must be valid, and the information on the accounts returned by the vendor must correspond to the customer. A success response for this route may include failures if an account could not be added and deletions if the account is removed by the end user, so it's important that the caller checks the response body.\n","operationId":"syncVendorExternalAccounts","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_vendor_accounts_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_vendor_accounts_response"}}},"description":"Result of syncing accounts through the vendor.\n"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Sync external accounts through a vendor, such as Plaid.","tags":["External Accounts"],"x-external":true},"summary":"External Accounts"},"/external_cards":{"get":{"description":"List external cards\n","operationId":"listExternalCards","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/customer_id_query"},{"$ref":"#/components/parameters/business_id_query1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_card_list_response"}}},"description":"External cards list"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List external cards","tags":["External Cards (alpha)"],"x-external":true}},"/external_cards/{external_card_id}":{"description":"External Card\n","get":{"description":"Get an external card\n","operationId":"getExternalCard","parameters":[{"$ref":"#/components/parameters/external_card_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_card_response"}}},"description":"External card details"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a external card","tags":["External Cards (alpha)"],"x-external":true},"summary":"Get External Card"},"/external_cards/tokens":{"post":{"description":"Create an external card from token - You must first tokenize the external card using the external card iframe. You will receive a token for the external card upon successful completion. This endpoint will persist the external card and associate it to a customer. The customer's name and address should match that of the external card as entered in the iframe. <br>NB: Tokens should be associated right away. Tokens not associated within 30 mins of creation will be invalidated.</br> NB: If a valid business_id is provided, the address verification for the external card will be done against the address of the business. Otherwise, the address of the customer will be used. In either case, the name of the customer will be used to match the name of the cardholder.\n","operationId":"createExternalCardFromToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_card_request"}}},"description":"Details of the card to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_card_response"}}},"description":"External card created"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create external card from token","tags":["External Cards (alpha)"],"x-external":true}},"/external_cards/transfers":{"get":{"description":"List external card transfer\n","operationId":"listExternalCardTransfers","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/customer_id_query_array1"},{"$ref":"#/components/parameters/external_card_id_query"},{"$ref":"#/components/parameters/originating_account_id_query_array"},{"$ref":"#/components/parameters/external_transfer_type_query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_list_response"}}},"description":"External transfer list"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List external transfers","tags":["External Cards (alpha)"],"x-external":true},"post":{"description":"Create a external card transfer\n","operationId":"createExternalCardTransfer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_request"}}},"description":"Details of the transfer to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_response"}}},"description":"External card transfer created"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create external card transfer","tags":["External Cards (alpha)"],"x-external":true}},"/external_cards/transfers/{transfer_id}":{"description":"External card transfer\n","get":{"description":"Get an external transfer\n","operationId":"getExternalCardTransfer","parameters":[{"$ref":"#/components/parameters/transfer_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_response"}}},"description":"External card transfer details"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get an external card transfer","tags":["External Cards (alpha)"],"x-external":true},"summary":"External Card Transfer"},"/internal_accounts":{"description":"The internal account resource is used for managing links to internal accounts where the funds are managed by integrators.\n","get":{"description":"Returns a list of all internal accounts.\n","operationId":"listInternalAccounts","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/internal_account_id_query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts_list"}}},"description":"List of internal accounts"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List internal accounts","tags":["Internal Accounts"],"x-external":true},"post":{"description":"Add an internal account\n","operationId":"addInternalAccounts","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_account"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_account"}}},"description":"The internal account added."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Add internal accounts","tags":["Internal Accounts"],"x-external":true},"summary":"Internal Accounts"},"/internal_accounts/{internal_account_id}":{"patch":{"description":"Patch internal account.\n","operationId":"patchInternalAccount","parameters":[{"$ref":"#/components/parameters/internal_account_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_account_patch"}}},"description":"Internal Account fields to be patched","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_account"}}},"description":"Updated internal account"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"461":{"$ref":"#/components/responses/account_closed"}},"summary":"Patch internal account","tags":["Internal Accounts"],"x-external":true},"summary":"Internal Accounts"},"/monitoring/alerts":{"get":{"operationId":"listAlerts","parameters":[{"$ref":"#/components/parameters/id_query1"},{"$ref":"#/components/parameters/person_id_query"},{"$ref":"#/components/parameters/business_id_query"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitoring_alert_list"}}},"description":"List of alerts."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List monitoring alerts","tags":["Monitoring"],"x-external":true,"x-status":"alpha"}},"/monitoring/alerts/{alert_id}":{"get":{"operationId":"getAlert","parameters":[{"$ref":"#/components/parameters/monitoring_alert_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitoring_alert"}}},"description":"A single monitoring alert."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Retrieve a monitoring alert","tags":["Monitoring"],"x-external":true,"x-status":"alpha"},"patch":{"operationId":"updateAlert","parameters":[{"$ref":"#/components/parameters/monitoring_alert_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitoring_alert"}}},"description":"Monitoring alert to update.","required":true},"responses":{"200":{"description":"Updated monitoring alert."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a monitoring alert","tags":["Monitoring"],"x-external":true,"x-status":"alpha"}},"/monitoring/subscriptions":{"get":{"operationId":"listSubscriptions","parameters":[{"$ref":"#/components/parameters/id_query1"},{"$ref":"#/components/parameters/person_id_query"},{"$ref":"#/components/parameters/business_id_query"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitoring_subscription_list"}}},"description":"List of monitoring subscriptions."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List monitoring subscriptions","tags":["Monitoring"],"x-external":true,"x-status":"alpha"},"post":{"description":"This endpoint is rarely needed. Since August 2022, watchlist monitoring is automatically enabled for all businesses and customers who are verified (KYC/KYB) through Synctera's platform.\n","operationId":"createSubscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitoring_subscription"}}},"description":"The monitoring subscription.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitoring_subscription"}}},"description":"The new monitoring subscription."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Subscribe a customer or business to monitoring","tags":["Monitoring"],"x-external":true,"x-status":"alpha"}},"/monitoring/subscriptions/{subscription_id}":{"delete":{"operationId":"deleteSubscription","parameters":[{"$ref":"#/components/parameters/monitoring_subscription_id"}],"responses":{"200":{"$ref":"#/components/responses/delete_response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete monitoring subscription","tags":["Monitoring"],"x-external":true,"x-status":"alpha"},"get":{"operationId":"getSubscription","parameters":[{"$ref":"#/components/parameters/monitoring_subscription_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitoring_subscription"}}},"description":"A single monitoring subscription."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Retrieve monitoring subscription","tags":["Monitoring"],"x-external":true,"x-status":"alpha"}},"/payment_schedules":{"get":{"description":"Get paginated list of payment schedules","operationId":"listPaymentSchedules","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/id_query2"},{"$ref":"#/components/parameters/account_id_query1"},{"$ref":"#/components/parameters/customer_id_query1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_schedule_list"}}},"description":"List of payment schedules"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List payment schedules","tags":["PaymentSchedules"],"x-external":true},"post":{"description":"Create a payment schedule","operationId":"createPaymentSchedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_schedule"}}},"description":"payment schedule to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_schedule"}}},"description":"Created payment schedule"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a payment schedule","tags":["PaymentSchedules"],"x-external":true},"summary":"PaymentSchedules"},"/payment_schedules/{payment_schedule_id}":{"patch":{"description":"Update a payment schedule","operationId":"patchPaymentSchedule","parameters":[{"$ref":"#/components/parameters/schedule_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_payment_schedule"}}},"description":"payment schedule to update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_schedule"}}},"description":"Updated payment schedule"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a payment schedule","tags":["PaymentSchedules"],"x-external":true}},"/payment_schedules/payments":{"get":{"description":"Get paginated list of payments","operationId":"listPayments","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/id_query2"},{"$ref":"#/components/parameters/payment_schedule_id_query"},{"$ref":"#/components/parameters/account_id_query1"},{"$ref":"#/components/parameters/customer_id_query1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_list"}}},"description":"List of payment schedules"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List payments","tags":["PaymentSchedules"],"x-external":true},"summary":"PaymentSchedules"},"/persons":{"get":{"description":"Retrieves paginated list of persons associated with the authorized requester.","operationId":"listPersons","parameters":[{"$ref":"#/components/parameters/id_query3"},{"$ref":"#/components/parameters/first_name"},{"$ref":"#/components/parameters/last_name"},{"$ref":"#/components/parameters/phone_number"},{"$ref":"#/components/parameters/email"},{"$ref":"#/components/parameters/ban_status"},{"$ref":"#/components/parameters/status3"},{"$ref":"#/components/parameters/is_customer"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/person_sort_by_query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/person_list"}}},"description":"List of persons."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List persons","tags":["Persons"],"x-external":true,"x-status":"alpha"},"post":{"description":"Create a person who may act as a personal customer or a director/officer/owner of a business. You can then verify the identity of this customer and associate them with other people and accounts.\n","operationId":"createPerson","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/person"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/person"}}},"description":"Created person representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a person","tags":["Persons"],"x-external":true,"x-status":"alpha"},"summary":"Persons"},"/persons/{person_id}":{"get":{"description":"Get person by ID.","operationId":"getPerson","parameters":[{"$ref":"#/components/parameters/person_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/person"}}},"description":"Person representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get person","tags":["Persons"],"x-external":true,"x-status":"alpha"},"patch":{"description":"Update person by ID.","operationId":"updatePerson","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/person_id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_person"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/person"}}},"description":"Updated person representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update person","tags":["Persons"],"x-external":true,"x-status":"alpha"},"summary":"Persons"},"/persons/{person_id}/prefill":{"post":{"description":"Prefill takes a subset of a person's information and automatically fills personally identifiable information (PII) required for know your customer (KYC) verification.\n","operationId":"prefillPerson","parameters":[{"$ref":"#/components/parameters/person_id_path"},{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/prefill_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/prefill_request"}}},"description":"Prefill response."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Prefill person","tags":["Persons"],"x-external":true,"x-status":"alpha"}},"/rdc/deposits":{"description":"The Remote Check Deposits collection represents all the deposits made using remote deposit capture associated with an account\n","get":{"description":"Retrieves a paginated list of the deposits made using remote deposit capture associated with an account","operationId":"listRdcDeposits","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deposit_list"}}},"description":"List of deposits made with remote deposit capture"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"}},"summary":"List Remote Check Deposits","tags":["Remote Check Deposit (beta)"],"x-external":true},"post":{"description":"Create a new deposit using remote deposit capture to an account\n","operationId":"createRdcDeposit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deposit"}}},"description":"Attributes of the Remote Check Deposit to create"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deposit"}}},"description":"Successful creation of a deposit using remote deposit capture"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Create a Remote Check Deposit","tags":["Remote Check Deposit (beta)"],"x-external":true},"summary":"Remote Check Deposits"},"/rdc/deposits/{deposit_id}":{"description":"The Remote Check Deposit represents one deposit made using remote deposit capture associated with an account\n","get":{"description":"Retrieves one deposit made using remote deposit capture associated with an account","operationId":"getRdcDeposit","parameters":[{"$ref":"#/components/parameters/deposit_id_path"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deposit"}}},"description":"Successful retrieval of a Remote Check Deposit"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Get Remote Check Deposit","tags":["Remote Check Deposit (beta)"],"x-external":true},"summary":"Remote Check Deposit by Id"},"/reconciliations":{"description":"The Reconcilations collections represents the jobs reconciling transactions.\n","get":{"description":"Retrieves paginated list of reconciliations","operationId":"listReconciliations","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reconciliation_list"}}},"description":"List of reconciliations"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List reconciliations","tags":["Reconciliations"],"x-external":true,"x-status":"alpha"},"post":{"description":"Create a new reconciliation job\n","operationId":"createReconciliation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reconciliation_input"}}},"description":"Reconciliation to perform"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reconciliation"}}},"description":"Successful creation of a reconciliation"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a reconciliation","tags":["Reconciliations"],"x-external":true,"x-status":"alpha"},"summary":"Reconciliations"},"/reconciliations/{reconciliation_id}":{"description":"The Reconcilations collections represents the jobs reconciling transactions.\n","get":{"description":"Retrieves one reconciliation by id","operationId":"getReconciliation","parameters":[{"$ref":"#/components/parameters/reconciliation_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reconciliation"}}},"description":"Successful retrieval of a reconciliation"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Get reconciliation","tags":["Reconciliations"],"x-external":true,"x-status":"alpha"},"summary":"Reconciliation by ID"},"/relationships":{"get":{"description":"Retrieves paginated list of relationships viewable by the authorized requester.","operationId":"listRelationships","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/from_person_id_query"},{"$ref":"#/components/parameters/from_business_id_query"},{"$ref":"#/components/parameters/to_business_id_query"},{"$ref":"#/components/parameters/relationship_type"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationships_list"}}},"description":"Relationship representation."},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List relationships","tags":["Relationships"],"x-external":true,"x-status":"alpha"},"post":{"description":"Create a party relationship.","operationId":"createRelationship","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship_in"}}},"description":"Party relationship to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship_in"}}},"description":"Created relationship representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"$ref":"#/components/responses/already_exists"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a relationship","tags":["Relationships"],"x-external":true,"x-status":"alpha"},"summary":"Relationships"},"/relationships/{relationship_id}":{"delete":{"description":"Delete party relationship by ID.","operationId":"deleteRelationship","parameters":[{"$ref":"#/components/parameters/relationship_id1"}],"responses":{"200":{"$ref":"#/components/responses/delete_response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete relationship","tags":["Relationships"],"x-external":true,"x-status":"alpha"},"get":{"description":"Get relationship by ID.","operationId":"getRelationship","parameters":[{"$ref":"#/components/parameters/relationship_id1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/relationship_in"}}},"description":"Relationship representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get relationship","tags":["Relationships"],"x-external":true,"x-status":"alpha"},"patch":{"description":"Update relationship by ID.","operationId":"updateRelationship","parameters":[{"$ref":"#/components/parameters/idempotency_key"},{"$ref":"#/components/parameters/relationship_id1"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_relationship_in"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_relationship_in"}}},"description":"Updated relationship representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/already_exists"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update relationship","tags":["Relationships"],"x-external":true,"x-status":"alpha"},"summary":"Relationship"},"/statements":{"get":{"description":"Get list of statements","operationId":"listStatements","parameters":[{"$ref":"#/components/parameters/account_id1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/statement_list"}}},"description":"List of statements for a given account"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List statements","tags":["Statements"],"x-external":true},"summary":"Statements"},"/statements/{statement_id}":{"get":{"description":"Get a statement","operationId":"getStatement","parameters":[{"$ref":"#/components/parameters/statement_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/statement"}}},"description":"statement"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a statement","tags":["Statements"],"x-external":true},"summary":"Statements"},"/transactions/internal_transfer":{"description":"An internal transfer is an immediate payment between two accounts within the same Fintech.","post":{"description":"Create an internal transfer","operationId":"createInternalTransfer","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_transfer"}}},"description":"Transfer request body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_transfer_response"}}},"description":"Transaction Response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create an internal transfer","tags":["Transactions"],"x-external":true},"summary":"Initiate an internal account-to-account transfer"},"/transactions/pending":{"description":"Pending transactions represent a \"hold\" of a paricular amount on an account balance.\n","get":{"description":"Get paginated list of pending transactions matching the provided filters\n","operationId":"listPendingTransactions","parameters":[{"$ref":"#/components/parameters/account_no"},{"$ref":"#/components/parameters/account_id2"},{"$ref":"#/components/parameters/from_date"},{"$ref":"#/components/parameters/to_date"},{"$ref":"#/components/parameters/status4"},{"$ref":"#/components/parameters/transaction_id1"},{"$ref":"#/components/parameters/type"},{"$ref":"#/components/parameters/subtype"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pending_transactions"}}},"description":"Paginated list of pending transactions"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List pending transactions","tags":["Transactions"],"x-external":true},"summary":"List pending transactions"},"/transactions/pending/{id}":{"description":"A pending transaction represent a \"hold\" of a paricular amount on an account balance.\n","get":{"description":"Get a pending transaction by its uuid\n","operationId":"getPendingTransactionByID","parameters":[{"$ref":"#/components/parameters/id1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pending_transaction"}}},"description":"Pending Transaction"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a pending transaction","tags":["Transactions"],"x-external":true},"summary":"Get pending transaction"},"/transactions/posted":{"description":"Posted transactions represent a completed money movement.\n","get":{"description":"Get paginated list of posted transactions matching the provided filters\n","operationId":"listPostedTransactions","parameters":[{"$ref":"#/components/parameters/account_no"},{"$ref":"#/components/parameters/account_id2"},{"$ref":"#/components/parameters/from_date"},{"$ref":"#/components/parameters/to_date"},{"$ref":"#/components/parameters/type"},{"$ref":"#/components/parameters/subtype"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/posted_transactions"}}},"description":"Paginated list of posted transactions"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List posted transactions","tags":["Transactions"],"x-external":true},"summary":"List posted transactions"},"/transactions/posted/{id}":{"description":"A posted transaction represents a completed money movement.\n","get":{"description":"Get a posted transaction by its uuid\n","operationId":"getPostedTransactionByID","parameters":[{"$ref":"#/components/parameters/id1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/posted_transaction"}}},"description":"Posted Transaction"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a posted transaction","tags":["Transactions"],"x-external":true},"summary":"Get posted transaction"},"/verifications":{"get":{"description":"List customer verification results.","operationId":"listVerifications1","parameters":[{"$ref":"#/components/parameters/id_query4"},{"$ref":"#/components/parameters/person_id_query"},{"$ref":"#/components/parameters/business_id_query"},{"$ref":"#/components/parameters/verification_type_query"},{"$ref":"#/components/parameters/result_query"},{"$ref":"#/components/parameters/include_history"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verification_list"}}},"description":"List verifications."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List verifications","tags":["KYC/KYB Verifications"],"x-external":true,"x-status":"alpha"},"post":{"description":"Upload evidence of an externally performed KYC/KYB.  You may use your own KYC/KYB provider and upload evidence of that result to Synctera instead of using Synctera's providers.\n","operationId":"createVerification","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verification"}}},"description":"Verification result to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verification"}}},"description":"Created verification."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a verification","tags":["KYC/KYB Verifications"],"x-external":true,"x-status":"alpha"}},"/verifications/{verification_id}":{"get":{"description":"Get customer verification result.","operationId":"getVerification1","parameters":[{"$ref":"#/components/parameters/verification_id1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verification"}}},"description":"Verification representation."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get verification","tags":["KYC/KYB Verifications"],"x-external":true,"x-status":"alpha"}},"/verifications/adhoc":{"description":"Check if an individual is on any watchlists. Intended for use before a transfer payment, to ensure that the payee is not flagged.\n","post":{"operationId":"verifyAdHoc","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/adhoc_verification_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/adhoc_verification_response"}}},"description":"successful check"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Check if an individual is on any watchlists","tags":["KYC/KYB Verifications"],"x-external":true},"summary":"Check if an individual is on any watchlists"},"/verifications/verify":{"post":{"description":"Initiate identity verification and run the specified identity checks.\n\nVerifying a personal customer requires that the following fields already be set:\n* `first_name`\n* `last_name`\n* `dob`\n* `email`\n* `phone_number`\n* `legal_address`\n* `ssn`\n\nVerifying a business customer requires that the following fields already be set:\n* `entity_name`\n* `legal_address`\n","operationId":"verify","parameters":[{"$ref":"#/components/parameters/idempotency_key"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verification_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verify_response"}}},"description":"Created identity request."},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Verify a customer's identity","tags":["KYC/KYB Verifications"],"x-external":true,"x-status":"alpha"}},"/webhooks":{"get":{"description":"List all webhooks","operationId":"listWebhooks1","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"in":"query","name":"is_enabled_only","schema":{"type":"boolean"},"x-external":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_list"}}},"description":"List of webhooks"},"401":{"$ref":"#/components/responses/unauthorized"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List webhooks","tags":["Webhooks"],"x-external":true},"post":{"description":"Create a webhook","operationId":"createWebhook1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}},"description":"Webhook to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}},"description":"Created webhook"},"401":{"$ref":"#/components/responses/unauthorized"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a webhook","tags":["Webhooks"],"x-external":true}},"/webhooks/{webhook_id}":{"delete":{"description":"Delete a webhook","operationId":"deleteWebhook","parameters":[{"$ref":"#/components/parameters/webhook_id1"}],"responses":{"200":{"$ref":"#/components/responses/delete_response"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete a webhook","tags":["Webhooks"],"x-external":true},"get":{"description":"Get a webhook","operationId":"getWebhook1","parameters":[{"$ref":"#/components/parameters/webhook_id1"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}},"description":"Webhook"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a webhook","tags":["Webhooks"],"x-external":true},"put":{"description":"Update a webhook","operationId":"updateWebhook","parameters":[{"$ref":"#/components/parameters/webhook_id1"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}},"description":"Webhook to update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"}}},"description":"Created webhook"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a webhook","tags":["Webhooks"],"x-external":true}},"/webhooks/{webhook_id}/events":{"get":{"description":"List webhook events. This response will not associate with the event response history.","operationId":"listEvents","parameters":[{"$ref":"#/components/parameters/webhook_id1"},{"deprecated":true,"description":"Start date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. start_date is alias of start_time and is deprecated. Please use start_time instead.","in":"query","name":"start_date","schema":{"format":"date","type":"string"},"x-external":true},{"deprecated":true,"description":"End date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. end_date is alias of end_time and is deprecated. Please use end_time instead.","in":"query","name":"end_date","schema":{"format":"date","type":"string"},"x-external":true},{"description":"Start time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.","in":"query","name":"start_time","schema":{"format":"date-time","type":"string"},"x-external":true},{"description":"End time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.","in":"query","name":"end_time","schema":{"format":"date-time","type":"string"},"x-external":true},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_list"}}},"description":"List of webhook events"},"401":{"$ref":"#/components/responses/unauthorized"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List webhook events","tags":["Webhooks"],"x-external":true}},"/webhooks/{webhook_id}/events/{event_id}":{"get":{"description":"Get webhook event by ID","operationId":"getEvent","parameters":[{"$ref":"#/components/parameters/webhook_id1"},{"description":"Webhook event ID","in":"path","name":"event_id","required":true,"schema":{"example":"30b341b8-8445-459a-8349-b3548b2aff53","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event"}}},"description":"Webhook event"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get webhook event","tags":["Webhooks"],"x-external":true}},"/webhooks/{webhook_id}/events/{event_id}/resend":{"post":{"description":"Resend a webhook event","operationId":"resendEvent","parameters":[{"$ref":"#/components/parameters/webhook_id1"},{"description":"Webhook event ID","in":"path","name":"event_id","required":true,"schema":{"example":"9e57eb8e-1795-4496-b3c5-06fcfdc7329f","format":"uuid","type":"string"}},{"description":"Delay the event triggering in seconds","in":"query","name":"delay","schema":{"maximum":3600,"minimum":0,"type":"integer"},"x-external":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event"}}},"description":"Resent webhook event"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Resend an event","tags":["Webhooks"],"x-external":true}},"/webhooks/trigger":{"post":{"description":"Trigger an specific event for webhook testing purpose","operationId":"triggerEvent","requestBody":{"content":{"application/json":{"schema":{"properties":{"event":{"$ref":"#/components/schemas/event_type1"}},"type":"object"}}},"description":"Provide an event type to trigger","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_trigger"}}},"description":"Triggered webhook event"},"401":{"$ref":"#/components/responses/unauthorized"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Trigger an event","tags":["Webhooks"],"x-external":true}},"/wipe":{"post":{"description":"Delete the customer and account related data, leaving other configuration data intact. This enables use cases such as bulk data deletion between tests.\nData associated with below resources will be deleted:\n  - Accounts\n  - Account applications\n  - ACH\n  - Businesses\n  - Cards\n  - Card images\n  - Cases\n  - Customers\n  - Disclosures\n  - External Accounts\n  - Internal Accounts\n  - Payment schedules and history\n  - Persons\n  - RDC\n  - Relationships\n  - Transactions (including for Internal Accounts)\n  - Verifications\n\nData associated with below resources will be retained:\n  - Account Templates\n  - API Keys\n  - Bank/Partner data\n  - Card product\n  - Disclosure document records\n  - Egress config\n  - Groups\n  - PII contract with vault\n  - Roles\n  - Users\n  - Webhooks\n","operationId":"wipeWorkspace","responses":{"204":{"description":"successfully wiped resources for a particular tenant"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete data","tags":["Sandbox Wipe (alpha)"],"x-external":true,"x-status":"alpha"},"summary":"Wipe"},"/wires":{"get":{"description":"Get paginated list of wires","operationId":"listWires","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page_token"},{"$ref":"#/components/parameters/status6"},{"$ref":"#/components/parameters/customer_id"},{"$ref":"#/components/parameters/originating_account_id"},{"$ref":"#/components/parameters/receiving_account_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wire_list"}}},"description":"List of wires"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List wires","tags":["Wires (alpha)"],"x-external":true,"x-status":"alpha"},"post":{"description":"Create an outgoing wire transfer","operationId":"createWire","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wire_request"}}},"description":"Wire transfer request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wire"}}},"description":"Created wire"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Send a wire","tags":["Wires (alpha)"],"x-external":true,"x-status":"alpha"},"summary":"Wire"},"/wires/{wire_id}":{"get":{"description":"Get a wire by id","operationId":"getWire","parameters":[{"$ref":"#/components/parameters/wire_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wire"}}},"description":"wire"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a wire by id","tags":["Wires (alpha)"],"x-external":true,"x-status":"alpha"},"patch":{"description":"Cancel an outgoing tranfer","operationId":"cancelWire","parameters":[{"$ref":"#/components/parameters/wire_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_transfer"}}},"description":"wire to update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wire"}}},"description":"Updated wire"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Cancel an outgoing wire","tags":["Wires (alpha)"],"x-external":true,"x-status":"alpha"},"summary":"Wire"}},"security":[{"bearerAuth":[]}],"servers":[{"description":"Production","url":"https://api.synctera.com/v0"},{"description":"Sandbox (no real world financial impact)","url":"https://api-sandbox.synctera.com/v0"}],"tags":[{"description":"Requests to create and manage account products, including fees, interest.","name":"Account Products"},{"description":"Request to create and manage accounts","name":"Accounts"},{"description":"Account Template","name":"Account Templates"},{"description":"Create and manage payments","name":"ACH"},{"description":"Create a credit application.","name":"Applications"},{"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.\n","name":"Businesses"},{"description":"Requests to issue and manage cards","name":"Cards"},{"description":"Push and pull from cards","name":"External Cards (alpha)"},{"description":"Requests to create and manage customers","name":"Customers"},{"description":"The disclosures resource is used to track the status of disclosures and\nensure that all parties have been shown the necessary disclosures to meet\nregulatory obligations.\n","name":"Disclosures"},{"description":"Request to create and manage documents.","name":"Documents"},{"description":"The External Account resource is used for managing links to accounts\nthat operate outside of the Synctera ecosystem.\n","name":"External Accounts"},{"description":"The internal account resource is used for managing links to internal\naccounts where the funds are managed by integrators.\n","name":"Internal Accounts"},{"description":"Requests to initiate customer verification.","name":"KYC Verification"},{"description":"Requests to manage monitoring subscriptions and alerts for customers.","name":"Monitoring"},{"description":"Request to create and manage payment_schedules","name":"Cronut"},{"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.\n","name":"Persons"},{"description":"Request to create and manage deposits using remote deposit capture","name":"Remote Check Deposit"},{"description":"Requests to create and manage reconciliation","name":"Reconciliations"},{"description":"Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations.\n","name":"Relationships"},{"description":"Request to create and manage statements","name":"Stately"},{"description":"Requests to generate simulated transactions","name":"Card Transaction Simulations"},{"description":"Create and manage transactions","name":"Transactions"},{"description":"Requests to initiate customer verification.","name":"KYC/KYB Verifications"},{"description":"Request to create and manage waitlists","name":"Waitlist"},{"description":"Request to enroll, renew, or cancel watchlist monitors","name":"Watchlist"},{"description":"Requests to generate simulated webhooks","name":"Card Webhook Simulations"},{"description":"Requests to create and manage webhooks","name":"Webhooks"},{"description":"Create and manage wire transfers","name":"Wires (alpha)"}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true,"samples-enabled":true}}