> ## Documentation Index > Fetch the complete documentation index at: https://docs.dintero.com/llms.txt > Use this file to discover all available pages before exploring further. # MATCH register search > Search the MATCH register for any potential matches related to fraud for the account scopes: - read:accounts:/match ## OpenAPI ````yaml /mintlify-docs/openapi/spec-management-auth.yaml post /accounts/{aid}/compliance-search/match openapi: 3.0.0 info: title: Account Management API description: > # Changelog All notable changes to the API. ## 2026-08-01 > **add**: Endpoint for updating a Grant > > - [PATCH /v1/accounts/{oid}/management/auth/client-grants/{id}](/management-auth-api/grants/aid_auths_client_grants_id_patch) ## 2026-07-31 > **add**: Add `seitatech` connection to Account `connections` > > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) ## 2026-07-30 > **add**: Add merchant support for requesting updates of the > account sandbox settings > > - [PUT /v1/accounts/{aid}/management/settings/sandbox](/management-auth-api/account-settings/aid_account_settings_sandbox_put) > - [GET /v1/accounts/{aid}/management/settings/sandbox](/management-auth-api/account-settings/aid_account_settings_sandbox_get) ## 2026-07-21 > **new** Add optional `configuration.auto_end_of_day` to store creation, and > a dedicated endpoint for updating it. Set `enabled` to false to disable the > automatic timed end-of-day and trigger it manually via the terminal > operations API instead. `configuration` is included in store details but > not in the store list. > > - [POST /v1/accounts/{aid}/management/stores](/management-auth-api/account-stores/aid_account_management_stores_post) > - [GET /v1/accounts/{aid}/management/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_get) > - [PATCH /v1/accounts/{aid}/management/stores/{store_id}/configuration](/management-auth-api/account-stores/aid_account_management_stores_sid_configuration_patch) ## 2026-07-10 > **update** Add `terminal_id` and `search` query parameters to filter terminals. > > - [GET /v1/accounts/{aid}/management/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_get) ## 2026-07-11 > **update** Add `status` and `search` query parameters to filter client collection. > > - [GET /v1/accounts/{aid}/auth/clients](/management-auth-api/clients/aid_auth_clients_get) ## 2026-06-26 > **update** Add `status`, `device_model`, and `device_serial_number` query parameters to filter terminals. > > - [GET /v1/accounts/{aid}/management/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_get) ## 2026-06-24 > **update** Include `ipp` in `requested_payment_methods` of Account onboarding > > - [POST /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) ## 2026-06-09 > **update** `store_id` is now optional when creating a store. If omitted, the server generates one (e.g. `T12345678-0001`). > > - [POST /v1/accounts/{aid}/management/stores](/management-auth-api/account-stores/aid_account_management_stores_post) ## 2026-06-08 > **update** Include `ipp` in `payment_methods` of new Payment approval > > - [GET /v1/accounts/{aid}/management/settings/approvals/payments](/management-auth-api/approvals/aid_management_settings_approvals_payment_get) > - [POST /v1/accounts/{aid}/management/settings/approvals/payments](/management-auth-api/approvals/aid_management_settings_approvals_payment_post) ## 2026-06-04 > **update** Include `links` in payout destination details response > > - [GET /v1/accounts/{aid}/payout-destinations/{payout_destination_id}](#operation/aid_mgmnt_payout_destinations_payout_destination_id_get) ## 2026-06-03 > **update** `device_model` removed from terminal create request. The model is always resolved from the serial number using terminal manufacture data. > > - [POST /v1/accounts/{aid}/management/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_post) > **update** Add `status_reason` to terminal responses. > > **update** Expand terminal `status` to include `ERROR`. > > - [GET /v1/accounts/{aid}/stores](/management-auth-api/account-stores/aid_account_management_stores_get) > - [GET /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_get) > - [GET /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_get) > - [GET /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_get) ## 2026-05-30 > **update** Store `form_submitter` details on created payout destination response > > - [POST /v1/accounts/{aid}/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_post) ## 2026-05-29 > Document minimum required fields to be set for POST account to enable `livemode` > > - [POST /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) ## 2026-05-22 > **update** Store `status` response field now includes all possible values: `ACTIVE`, `PENDING`, `SUSPENDED`, `DELETED`, `ERROR`. > > - [GET /v1/accounts/{aid}/management/stores](/management-auth-api/account-stores/aid_account_management_stores_get) > - [GET /v1/accounts/{aid}/management/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_get) ## 2026-05-21 > **update** Add `status` query parameter to filter stores by status. > > - [GET /v1/accounts/{aid}/management/stores](/management-auth-api/account-stores/aid_account_management_stores_get) > **update** Add `enrollment` field to store details response. > > - [GET /v1/accounts/{aid}/management/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_get) > **update** New stores are created with `status: PENDING` by default. > **break** `organization_number` cannot be changed after store creation. > > - [PUT /v1/accounts/{aid}/management/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_put) > **update** Terminal creation returns `400` when the store has no payout destination. > > - [POST /v1/accounts/{aid}/management/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_post) > **update** Add `PENDING` and `ACTION_REQUIRED` terminal statuses. > > - [GET /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_get) > - [GET /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_get) ## 2026-05-20 > **break** The `store_id` field in the POST terminal request body now expects the > client-supplied `store_id` (e.g. `S312`) instead of the system-generated store `id` > (e.g. `P12600030-0001`). > > - [POST /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_post) ## 2026-05-16 > **break** Remove `PUT /v1/accounts/{aid}/terminals/{terminal_id}` endpoint. > > - [GET /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_get) > - [DELETE /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_delete) > **break** `store_name`, `phone_number`, and `organization` are now required fields when creating or updating a store. > > - [POST /v1/accounts/{aid}/stores](/management-auth-api/account-stores/aid_account_management_stores_post) > - [PUT /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_put) ## 2026-05-15 > **breaking** Refactor `stores.address` to `Address` object and remove requirement for `store.store_name` in GET endpoint for `/{oid}/payout-destinations/{payout_destination_id}` > - [GET /v1/accounts/{aid}/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get_by_id) - ## 2026-05-13 > **update** Add `payout_destination_name` and `payout_destination_description` to `AuthPayoutDestinationReadOnly` > > - [GET /v1/accounts/{aid}/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get_by_id) > - [GET /v1/accounts/{oid}/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get) ## 2026-05-08 > **update** Add `terminals` and `stores` to GET endpoint for `/{oid}/payout-destinations/{payout_destination_id}` > > - [GET /v1/accounts/{aid}/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get_by_id) ## 2026-05-07 > **update** `store_id` is now required when creating a terminal. > > - [POST /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_post) ## 2026-05-06 > **update** Add `supported_invoice_channels` support for Kravia connection update. > > - GET [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_get) > - PUT [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_put) ## 2026-05-03 > **new** POST endpoint for `/{aid}/payout-destinations` and GET endpoint for `/{oid}/payout-destinations/{payout_destination_id}` > > - [GET /v1/accounts/{aid}/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get_by_id) > - [POST /v1/accounts/{aid}/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_post) ## 2026-05-02 > **new** New query parameters `search` and `creation_state` for Price package collection > > - [GET /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_get) ## 2026-05-01 > **new** Update payout destination. > > - [PATCH /v1/accounts/{oid}/management/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_by_id_patch) > **update** Add payout_interval_type value `"manual"`. > > - [PATCH /v1/accounts/{oid}/management/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_by_id_patch) ## 2026-04-29 > **update** Add `terminal_id` query parameter to filter stores by terminal. > > - [GET /v1/accounts/{aid}/stores](/management-auth-api/account-stores/aid_account_management_stores_get) > **break** Remove deprecated `/management/` path prefixes for stores, terminals and payout-destinations. > Use the plain paths instead. > > - [GET /v1/accounts/{aid}/stores](/management-auth-api/account-stores/aid_account_management_stores_get) > - [POST /v1/accounts/{aid}/stores](/management-auth-api/account-stores/aid_account_management_stores_post) > - [GET /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_get) > - [PUT /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_put) > - [DELETE /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_delete) > - [GET /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_get) > - [POST /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_post) > - [GET /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_get) > - [PUT /v1/accounts/{aid}/terminals/{terminal_id}](#operation/aid_account_management_terminals_termid_put) > - [DELETE /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_delete) > - [GET /v1/accounts/{oid}/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get) > - [PATCH /v1/accounts/{oid}/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_by_id_patch) > - [POST /v1/accounts/{oid}/payout-destinations/{payout_destination_id}/payouts](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_payouts_post) > **update** `device_model` on terminals is now an enum. Accepted values are `SATURN1000`, `Saturn_S1F4_Pro`, `S1P2`. > > - [POST /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_post) > - [PUT /v1/accounts/{aid}/terminals/{terminal_id}](#operation/aid_account_management_terminals_termid_put) > - [GET /v1/accounts/{oid}/payout-destinations/{payout_destination_id}](#operation/oid_mgmnt_payout_destinations_get_by_id) > - [POST /v1/accounts/{oid}/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_post) ## 2026-04-27 > **update** Add `email`, `website`, and `phone_number` to payout destinations. > > - [GET /v1/accounts/{oid}/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get) > - [PATCH /v1/accounts/{oid}/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_by_id_patch) ## 2026-04-17 > **new** Add plain path aliases for stores, terminals and payout-destinations. > The `/management/` prefix is no longer required. > > - [GET /v1/accounts/{aid}/stores](/management-auth-api/account-stores/aid_account_management_stores_get) > - [POST /v1/accounts/{aid}/stores](/management-auth-api/account-stores/aid_account_management_stores_post) > - [GET /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_get) > - [PUT /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_put) > - [DELETE /v1/accounts/{aid}/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_delete) > - [GET /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_get) > - [POST /v1/accounts/{aid}/terminals](/management-auth-api/account-terminals/aid_account_management_terminals_post) > - [GET /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_get) > - [PUT /v1/accounts/{aid}/terminals/{terminal_id}](#operation/aid_account_management_terminals_termid_put) > - [DELETE /v1/accounts/{aid}/terminals/{terminal_id}](/management-auth-api/account-terminals/aid_account_management_terminals_termid_delete) > - [GET /v1/accounts/{oid}/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get) > - [PATCH /v1/accounts/{oid}/payout-destinations/{payout_destination_id}](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_by_id_patch) > - [POST /v1/accounts/{oid}/payout-destinations/{payout_destination_id}/payouts](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_payouts_post) ## 2026-04-09 > Add endpoint to onboard merchant to Seitatech and endpoint to get the connection. > > - GET [/v1/accounts/{aid}/management/settings/connections/seitatech](/management-auth-api/account-connections/aid_account_settings_connections_seitatech_get) > - POST [/v1/accounts/{aid}/management/settings/connections/seitatech](/management-auth-api/account-connections/aid_account_settings_connections_seitatech_post) ## 2026-04-08 > **break** Rename `locations` to `stores` in management API. The `/management/locations` endpoints are now `/management/stores`. Related properties renamed: `location_id` to `store_id`, `location_name` to `store_name`, `number_of_locations` to `number_of_stores`. Webhook events renamed from `account_location_*` to `account_store_*`. > > - [GET /v1/accounts/{aid}/management/stores](/management-auth-api/account-stores/aid_account_management_stores_get) > - [POST /v1/accounts/{aid}/management/stores](/management-auth-api/account-stores/aid_account_management_stores_post) > - [GET /v1/accounts/{aid}/management/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_get) > - [PUT /v1/accounts/{aid}/management/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_put) > - [DELETE /v1/accounts/{aid}/management/stores/{store_id}](/management-auth-api/account-stores/aid_account_management_stores_sid_delete) ## 2026-04-01 > **new** On-demand payouts. > > - [POST /v1/accounts/{oid}/management/payout-destinations/{payout_destination_id}/payouts](/management-auth-api/payout-destinations/oid_mgmnt_payout_destinations_payouts_post) ## 2026-03-25 > **new** Add endpoint for listing Bambora IPP submerchant onboardings > > - [GET /v1/accounts/{aid}/management/settings/connections/bambora-ipp-submerchants](/management-auth-api/account-connections/aid_account_settings_connections_bambora_ipp_get) ## 2026-03-20 > **update** Add `payment_product_type_category` as a price package price dimension. Also add enum values and descriptions for the price `name` property. > > - [GET /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_get) > - [POST /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_post) > - [PUT /v1/accounts/{oid}/management/price-packages/{price_package_id}](/management-auth-api/price-packages/aid_mgmnt_price_packages_put) > - [GET /v1/accounts/{aid}/management/price-package](/management-auth-api/account-price-package/aid_account_price_package_get) > **update** Update Mastercard Match terminate and search response to use new values from Match Pro API. Replace `cat_flag` with `is_proprietorship` and `is_transaction_laundering` in terminate request. Update all MATCH response definitions per MATCH Pro spec, and use snake_case for all schemas. > > - [POST /v1/accounts/{aid}/compliance-search/match/terminate](/management-auth-api/account-fraud-search/accounts_aid_search_match_terminate_merchant_post) > - [POST /v1/accounts/{aid}/compliance-search/match](/management-auth-api/account-fraud-search/accounts_aid_search_match_post) > - [GET /v1/accounts/{aid}/compliance-search/match/{irn}](/management-auth-api/account-fraud-search/accounts_aid_search_match_get) ## 2026-03-11 > **update** Add `TERMINATED` to approval status for approvals filtering and response status. > > - [GET /v1/accounts/{aid}/management/settings/approvals/payments](/management-auth-api/approvals/aid_management_settings_approvals_payment_get) > - [GET /v1/accounts/{aid}/management/settings/approvals/payout-destinations](/api-reference/approvals/aid_management_settings_approvals_payout_destinations_get) ## 2026-03-09 > **new** New query parameters for Payout destination collection > > - [GET /v1/accounts/{aid}/management/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get) ## 2026-03-04 > **update** Add `ipp` Checkout service feature > > - [PUT /v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - [GET /v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) ## 2026-02-25 > **update** Add `organization.country` and `organization.type` to location organization input. > > - [POST /v1/accounts/{aid}/management/locations](#operation/aid_account_management_locations_post) > - [PUT /v1/accounts/{aid}/management/locations/{location_id}](#operation/aid_account_management_locations_lid_put) ## 2026-02-23 > **update** Add `payout_interval_type`, `number_of_locations`, `number_of_terminals` to `AuthPayoutDestinationReadOnly` > > - [GET /v1/accounts/{aid}/managment/payout-destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get) ## 2026-02-21 > **update** Add `kravia` to `payment_methods` of `ApprovalPayments` > > - [GET /v1/accounts/{aid}/management/settings/approvals/payments](/management-auth-api/approvals/aid_management_settings_approvals_payment_get) > - [POST /v1/accounts/{aid}/management/settings/approvals/payments](/management-auth-api/approvals/aid_management_settings_approvals_payment_post) ## 2026-02-20 > **update** Add support for `terminals` to location responses and `terminals_summary` to location collection entries. > > **update** Add `status` to terminal. > > - [GET /v1/accounts/{aid}/management/locations](#operation/aid_account_management_locations_get) > - [GET /v1/accounts/{aid}/management/locations/{location_id}](#operation/aid_account_management_locations_lid_get) > - [ PUT /v1/accounts/{aid}/management/locations/{location_id}](#operation/aid_account_management_locations_lid_put) > - [DELETE /v1/accounts/{aid}/management/locations/{location_id}](#operation/aid_account_management_locations_lid_delete) ## 2026-02-28 > Add endpoint to onboard merchant to Two and endpoint to get the connection. > > - GET [/v1/accounts/{aid}/management/settings/connections/two](/management-auth-api/account-connections/aid_account_settings_connections_two_get) > - POST [/v1/accounts/{aid}/management/settings/connections/two](/management-auth-api/account-connections/aid_account_settings_connections_two_post) ## 2026-02-13 > **update** Add `invoice_delivery_method` support for Kravia connection. > > - GET [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_get) > - POST [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_post) > > **new** Add endpoint for updating Kravia invoice delivery mode. > - PUT [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_put) ## 2026-02-10 > **update** Add `website` and `coordinates` properties to [location management endpoints](#tag/account-locations) ## 2026-01-16 > **update** Add `allowed_merchant_category_codes` property to Account `onboarding` > > Restricts the MCC codes available for selection during merchant onboarding. > > - GET [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - PUT [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) ## 2026-01-12 > **new** New query parameter for accounts collection: `services` > > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) ## 2025-12-31 > **update** Document support for 404 status from callback endpoint > > - [POST /v1/accounts/{aid}/management/settings/cdd/cases/{id}/callback](/management-auth-api/account-cdd/aid_management_settings_cdd_cases_callback) ## 2025-12-16 > **update** add `operator_payout_destination` property to location management endpoints > > [GET location details](#operation/aid_account_management_locations_get) > [GET location list](#operation/aid_account_management_locations_lid_get) ## 2025-12-15 > **update** Added `location_name` and `number_of_terminals` properties to the [location endpoints](#tag/account-locations) ## 2025-12-09 > **update** remove `device_serial_number` property for update operation > > [PUT /v1/accounts/{aid}/management/terminals/{terminal_id}](#operation/aid_account_management_terminals_termid_put) ## 2025-12-09 > - Removed entity management endpoints for `/entities` and `/transfer-instruments` > - Removed POST endpoint for entity management `/payout-destinations` > - Updated [GET payout destinations](/management-auth-api/payout-destinations/aid_mgmnt_payout_destinations_get) ## 2025-11-20 > **update** Add `public_business_name` to `AuthenticatedAccountUser` > > - GET [/v1/account/user](/management-auth-api/account-users/account_user_get) ## 2025-10-31 > **new** Add new `locations` and `terminals` endpoints to replace documented entity API > - [POST/GET/DELETE locations](#tag/account-locations) > - [POST/GET/DELETE terminals](#tag/account-terminals) ## 2025-10-28 > **update** Add `configuration` property to Kravia connection response to include merchant configuration details. > > - GET [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_get) ## 2025-10-27 > Add endpoint to onboard merchant to Kravia and endpoint to get the connection. > > - GET [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_get) > - POST [/v1/accounts/{aid}/management/settings/connections/kravia](/management-auth-api/account-connections/aid_account_settings_connections_kravia_post) ## 2025-10-20 > Add endpoint to onboard merchant to Click-to-pay and endpoint to get the connection. > > - GET [/v1/accounts/{aid}/management/settings/connections/clicktopay](/management-auth-api/account-connections/aid_account_settings_connections_visa_click_to_pay_get) > - POST [/v1/accounts/{aid}/management/settings/connections/clicktopay](/management-auth-api/account-connections/aid_account_settings_connections_visa_click_to_pay_post) ## 2025-10-06 > Remove pattern requirement for `billing.billing_statement.name` > > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - PUT [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - POST [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - GET [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - PUT [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - DELETE [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete) ## 2025-09-25 > Add new property `public_business_name` to Account `company` > Represents the public business name of the company, also known as "Doing business as" business name. > > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - PUT [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - POST [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - GET [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - PUT [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - DELETE [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete) ## 2025-09-15 > Add new scope `write:accounts:/assets` for creating upload URLs > Extend the create upload URL endpoint with `write:dintero:/management/accounts` access > > - POST [v1/accounts/{aid}/management/assets](/management-auth-api/account-assets/aid_account_assets_post) ## 2025-09-09 > Support more mime types for creating an upload URL > > - POST [v1/accounts/{aid}/management/assets](/management-auth-api/account-assets/aid_account_assets_post) ## 2025-08-27 > Add new property `attachments` to Account > > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - PUT [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - POST [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - GET [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - PUT [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - DELETE [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete) ## 2025-08-26 > Add new property `terms` to Account `company` > > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - PUT [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - POST [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - GET [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - PUT [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - DELETE [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete) ## 2025-08-25 > Add new property `contacts` to Account `company` > > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - PUT [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - POST [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - GET [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - PUT [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - DELETE [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete) ## 2025-08-22 > Add new property `billing_statement` to Account `billing` > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - PUT [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - POST [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - GET [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - PUT [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - DELETE [/v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete) ## 2025-08-19 > Add new property `onboarding` to Account settings > > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - PUT [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) ## 2025-06-01 > Add new endpoints for Entity Management > - [Entities](#tag/entities) > - [Stores](#tag/stores) > - [Transfer Instruments](#tag/transfer-instruments) > - [Payout Destinations](#tag/payout-destinations) ## 2025-05-12 > Add `country` query parameter to accounts collection > > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) ## 2025-04-01 > Adds Mastercard Tokenization enrollment > > - POST [/v1/accounts/{aid}/management/settings/connections/mastercard-tokenization](/management-auth-api/account-connections/aid_account_settings_connections_mastercard_tokenization_post) > - GET [/v1/accounts/{aid}/management/settings/connections/mastercard-tokenization](/management-auth-api/account-connections/aid_account_settings_connections_mastercard_tokenization_get) > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) ## 2025-03-31 > **new** Add support for updating API Client name and description > - [PATCH /v1/accounts/{oid}/auth/clients/{id}](/management-auth-api/clients/aid_auths_clients_id_patch) > **new** Document support for new dintero scopes > - [POST /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_post) > - [PUT /v1/accounts/{oid}/management/price-packages/{price_package_id}](/management-auth-api/price-packages/aid_mgmnt_price_packages_put) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}/price-packages](/management-auth-api/accounts/aid_account_settings_price_packages_put) ## 2025-03-02 > **new** `source_price_package_id` property in `PricePackageMeta` definition to keep track of the price package a price package is based on. > > - [GET /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_get) > - [POST /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_post) ## 2025-03-01 > Endpoint for signing up to Swish PayFac > > - [POST /management/settings/connections/swish-payfac](/management-auth-api/account-connections/aid_account_settings_connections_swish_payfac_post) > Adds Dintero PSP connection. > > - POST [/v1/accounts/{aid}/management/settings/connections/dintero-psp](/management-auth-api/account-connections/aid_account_settings_connections_dintero_psp_post) > - GET [/v1/accounts/{aid}/management/settings/connections/dintero-psp](/management-auth-api/account-connections/aid_account_settings_connections_dintero_psp_get) > Changes to Visa Tokenization enrollment, rename from visa-tokens to visa-tokenization > > - POST [/v1/accounts/{aid}/management/settings/connections/visa-tokenization](/management-auth-api/account-connections/aid_account_settings_connections_visa_tokenization_post) > - GET [/v1/accounts/{aid}/management/settings/connections/visa-tokenization](/management-auth-api/account-connections/aid_account_settings_connections_visa_tokenization_get) > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > Changes to 3D-Secure enrollment, make the API stateful and algin it to the other connections. > > - POST [/v1/accounts/{aid}/management/settings/connections/mastercard-3ds](/management-auth-api/account-connections/aid_account_settings_connections_mastercard_3ds_post) > - GET [/v1/accounts/{aid}/management/settings/connections/mastercard-3ds](/management-auth-api/account-connections/aid_account_settings_connections_mastercard_3ds_get) > - GET [/v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - GET [/v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) ## 2025-02-03 > Support individual sellers in "New seller approval" endpoint. > > - POST [/v1/accounts/{oid}/management/settings/approvals/payout-destinations](/api-reference/approvals/aid_management_settings_approvals_payout_destinations_post) ## 2025-02-01 > Extend update price packages endpoint with new query parameter `remove_default_price_package` to support removing the default price package from the partner configuration of a given partner account. > > - [PUT /v1/accounts/{oid}/management/accounts/{aid}/price-packages](/management-auth-api/accounts/aid_account_settings_price_packages_put) ## 2025-02-02 > Extend account users API with new query parameter `search` to look up users by email and/or name > > - [GET /v1/accounts/{oid}/management/users](/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_get) ## 2025-02-01 > Extend partner API with new optional property for account: `configuration` > The `configuration` property can be used to set various configurations on a > partner account. > > Currently, only "default price package" is supported—which lets you configure > a given partner account with a default price package that should be assigned > to new merchants created from said partner, if nothing else is specified. > > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}/price-packages](/management-auth-api/accounts/aid_account_settings_price_packages_put) > - [GET /management/settings](/management-auth-api/account-settings/aid_account_aid_get) > Extend update price packages endpoint with new query parameter `remove_default_price_package` to support removing the default price package from the partner configuration of a given partner account. > > - [PUT /v1/accounts/{oid}/management/accounts/{aid}/price-packages](/management-auth-api/accounts/aid_account_settings_price_packages_put) ## 2025-01-07 > Add endpoint for enrollment to 3D-Secure with Mastercard > > - [PUT /v1/accounts/{oid}/management/settings/connections/3d-secure-enrollment](#operation/aid_account_settings_connections_3ds_enrollment_post) > Set merchant category codes as a required field. > > - [POST /v1/accounts/{aid}/compliance-search/vmss/terminate](/management-auth-api/account-fraud-search/accounts_aid_search_vmss_terminate_merchant_post) ## 2025-01-01 > Extend price package API with PUT price package endpoint for updating an > existing price package. > > - [PUT /v1/accounts/{oid}/management/price-packages/{price_package_id}](/management-auth-api/price-packages/aid_mgmnt_price_packages_put) ## 2024-12-09 > Add endpoint for adding merchant to Visa Merchant Screening Service. > Make category and tradeOverInternet optional in VMSS inquiry request. > > - [POST /v1/accounts/{aid}/compliance-search/vmss/terminate](/management-auth-api/account-fraud-search/accounts_aid_search_vmss_terminate_merchant_post) > - [POST /v1/accounts/{aid}/compliance-search/vmss](/management-auth-api/account-fraud-search/accounts_aid_search_vmss_post) ## 2024-11-12 > Add endpoint for querying Visa Merchant Screening Service. > > - [POST /v1/accounts/{aid}/compliance-search/vmss](/management-auth-api/account-fraud-search/accounts_aid_search_vmss_post) ## 2024-11-01 > Extend partner API with additional optional read-only property for account > `prev_credit_rating`. > > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - [POST /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) ## 2024-11-01 > Add option to filter price packages by price package ID with new query parameter. > > - [GET /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_get) ## 2024-10-17 > Add `pricing_conditions` to `price_package` to support defining pricing conditions for the price package. > - [POST /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_post) ## 2024-10-04 > Remove requirement for `price_package_id` in `custom_price_package` when creating an account. > - [POST /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) ## 2024-10-03 > Add endpoint for getting price package on account > - [GET /v1/accounts/{oid}/management/accounts/{aid}/price-package](/management-auth-api/account-price-package/aid_account_price_package_get) ## 2024-10-02 > Revert adding endpoint and definitions for price package comparison ## 2024-10-01 > Extend endpoint to support archiving active payout destination approvals. > > - [DELETE /v1/accounts/{aid}/management/settings/approvals/payout-destinations/{id}](#aid_management_settings_approvals_payout_destinations_id_delete) ## 2024-09-11 > **Break** Change body for sending termination inquiry > **Break** Change URL for MATCH search to avoid conflict with existing API > Add endpoint for adding a terminated merchant to MATCH > Add enum for termination reason code > > - [POST /v1/accounts/{aid}/compliance-search/match/terminate](/management-auth-api/account-fraud-search/accounts_aid_search_match_terminate_merchant_post) > - [POST /v1/accounts/{aid}/compliance-search/match](/management-auth-api/account-fraud-search/accounts_aid_search_match_post) > - [GET /v1/accounts/{aid}/compliance-search/match/{irn}](/management-auth-api/account-fraud-search/accounts_aid_search_match_get) ## 2024-09-06 > Add endpoints for sending termination inquiry to Mastercard MATCH and fetching > result of a termination inquiry by its Inquiry Reference Number (IRN) > > - [POST /v1/accounts/{aid}/search/match](/management-auth-api/account-fraud-search/accounts_aid_search_match_post) > - [GET /v1/accounts/{aid}/search/match/{irn}](/management-auth-api/account-fraud-search/accounts_aid_search_match_get) ## 2024-08-13 > - Add `custom_price_package` when creating an account. This property can be used to create a new custom price package for the account. > - Add new endpoint for comparing products in price packages. > - Add `creation_state` to price package properties to indicate if the price package is a custom price package or not. > > - [POST /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - [GET /v1/accounts/{oid}/management/price-packages/diff/{pid}](#operation/aid_mgmnt_price_packages_diff_pid_get) ## 2024-08-12 > - Revert change to extend `invites` property when creating an account > - Add a new property `invite_users` property that replaces the extended spec > - for backwards compatibility, the `invites` property will still be supported > - [POST /v1/accounts/{aid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) ## 2024-08-06 > Extend `invites` property when creating an account > with support for first name and last name. > Include optional `invitation_note` property when creating an account > that can be used to add a note to the invitation email. > > - [POST /v1/accounts/{aid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) ## 2024-07-01 > Extend the account services with optional read-only features properties > to track the service feature requested by merchant and their current > status > Extend endpoint for updating account settings with support for > updating services features > > - [PUT /v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - [POST /management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) ## 2024-05-31 > Extend partner API with additional optional read-only properties for account > with `most_expensive_product_price`, `gift_card_revenue_percentage`, > `credit_rating`, and `currency` > > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) ## 2024-04-30 > Add support for configuring TOTP MFA for account user > > - [PUT /v1/account/user/mfa/totp](/management-auth-api/account-users/account_user_mfa_totp_put) ## 2024-03-31 > Add `form_submitter` to approvals. Add `payout_interval_type` payout destination approvals. > > - [POST /v1/accounts/{aid}/management/settings/approvals/payments](/management-auth-api/approvals/aid_management_settings_approvals_payment_post) > - [POST /v1/accounts/{aid}/management/settings/approvals/payout-destinations](/api-reference/approvals/aid_management_settings_approvals_payout_destinations_post) ## 2024-02-22 > Add `invites` and `actions` to creation of account > > - [POST /v1/accounts/{aid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) ## 2024-02-01 > Add new payment option `billie` when applying for payment methods > > - [POST /v1/accounts/{aid}/management/settings/approvals/payments](/management-auth-api/approvals/aid_management_settings_approvals_payment_post) ## 2024-01-01 > Add new payment method `klarna.billie` > > - [POST /management/settings/connections/klarna](/management-auth-api/account-connections/aid_account_settings_connections_klarna_post) > - [GET /management/settings/connections/klarna](/management-auth-api/account-connections/aid_account_settings_connections_klarna_get) > Add new price package APIs. New endpoint for managing price packages > that can be used when creating new accounts via the partner API > > - [GET /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_get) > - [POST /v1/accounts/{oid}/management/price-packages](/management-auth-api/price-packages/aid_mgmnt_price_packages_post) > - [PUT /v1/accounts/{oid}/management/price-packages/{price_package_id}@custom-price-packages](#operation/aid_mgmnt_price_packages_ppid_custom_post) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}/price-packages](/management-auth-api/accounts/aid_account_settings_price_packages_put) ## 2023-12-01 > Add endpoints for Visa Tokenization connection signup > > - [POST /v1/accounts/{aid}/management/settings/connections/visa-tokens](#operation/aid_account_settings_connections_visa_tokens_post) > - [GET /v1/accounts/{aid}/management/settings/connections/visa-tokens](#operation/aid_account_settings_connections_visa_tokens_get) > Extend bambora connection with ability to set token_scope > > - [POST /management/settings/connections/bambora/{callback_reference}](/management-auth-api/account-connections/aid_account_settings_connections_bambora_callback_post) > Extend the account user with new aggrement property that can be used > to track the terms and conditions accepted by the account user > > - [POST /management/users](/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_post) > - [PUT /management/users/{uid}](/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_put) > - [GET /account/user](/management-auth-api/account-users/account_user_get) ## 2023-11-01 > Extend partner API with additional optional properties for account > with `price_package`, `sale_channel` remove unsupported > `statistics.latest` > > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > Extend partner API with additional optional read-only properties for account > with `payment_case_status`, `projected_sales`, `average_transaction_value` > `merchant_category_code` and `delivery_timeline` > > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > Add new endpoint for archiving payout destination approvals that are not active. > > - [DELETE /v1/accounts/{aid}/management/settings/approvals/payout-destinations/{id}](#aid_management_settings_approvals_payout_destinations_id_delete) ## 2023-09-01 > Add new endpoint for posting Bambora Direct connection > > - [POST /management/settings/connections/bambora-direct](/management-auth-api/account-connections/aid_account_settings_connections_bambora_direct_post) > > NB! **Deprecates** old Bambora connection endpoint: > > - [POST /management/settings/connections/bambora](/management-auth-api/account-connections/aid_account_settings_connections_bambora_post) ## 2023-08-01 > Extend partner API with additional properties for account with > `statistics.metrics`, `permissions`, `company` and applicant. > > - [POST /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](#tagoperation/aid_accounts_aid_put) > - [POST /v1/accounts/{oid}/signup](/management-auth-api/account-onboarding/accounts_oid_signup_post) ## 2023-06-01 > Extend response bodies with `approvals_payments_statuses` and `approvals_payout_destinations_statuses` for partners accounts management. > > - [POST /management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - [GET /management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - [GET /management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > - [PUT /management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - [DELETE /management/accounts/{aid}](/management-auth-api/accounts/aid_mgmnt_accounts_aid_delete) > Add new endpoints for managing Bambora PayFac connections > > - [POST /management/settings/connections/bambora-payfac](/management-auth-api/account-connections/aid_account_settings_connections_bambora_payfac_post) > - [GET /management/settings/connections/bambora-payfac](#operation/aid_account_settings_connections_bambora_payfac_get) ## 2023-04-01 > Add new endpoints for managing Klarna connection > > - [POST /management/settings/connections/klarna](/management-auth-api/account-connections/aid_account_settings_connections_klarna_post) > - [GET /management/settings/connections/klarna](/management-auth-api/account-connections/aid_account_settings_connections_klarna_get) ## 2023-01-20 > Extend applicants with optional signup_reference. ## 2022-10-06 > Payout destinations are now referred to as Sellers, the data model is unchanged. ## 2022-07-01 > **Break** Require `includes=events.case.contracts` to get CDD contract details > from cases endpoint. The default response will now by default exclude contract > details from response > > - [GET /v1/accounts/{aid}/management/settings/cdd/cases](/management-auth-api/account-cdd/aid_management_settings_cdd_cases_get) ## 2022-06-01 > Add support for filtering sub-accounts on `connection`, `connection_status` and `payment_options` > > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) ## 2022-05-01 > Add support for including `payout_destination_name` and > `payout_destination_description` properties when creating diligence cases > > - [POST /v1/accounts/{aid}/management/settings/cdd/cases](/management-auth-api/account-cdd/aid_management_settings_cdd_cases_post) > - [GET /v1/accounts/{aid}/management/settings/cdd/cases](/management-auth-api/account-cdd/aid_management_settings_cdd_cases_get) > - [POST /v1/accounts/{aid}/management/settings/approvals/payout-destinations](/api-reference/approvals/aid_management_settings_approvals_payout_destinations_post) > - [GET /v1/accounts/{aid}/management/settings/approvals/payout-destinations](/api-reference/approvals/aid_management_settings_approvals_payout_destinations_get) > Add support for updating `payex`, `collector`, `swish` and `bambora` connections > > - [POST /v1/accounts/{oid}/management/accounts/{aid}/connections/{connection}/events](/management-auth-api/accounts/aid_accounts_aid_connections_events_post) ## 2022-04-01 > Add support for customer user login via Open ID connect. Configure `oidc` in > the client grant and use the new authorize endpoint to let the user be > verified and identified by external authorization server. The authorization > code received after authorization received by the user can be used to get a > Dintero access token via the token endpoint > > - [POST /v1/accounts/{oid}/auth/client-grants](/management-auth-api/grants/aid_auths_client_grants_post) > - [GET /v1/accounts/{oid}/auth/oidc/authorize](/management-auth-api/authenticate/aid_auths_oidc_authorize_get) > - [POST /v1/accounts/{oid}/auth/oidc/token](/management-auth-api/authenticate/aid_auths_oidc_token_post) ## 2022-02-08 > Add new endpoints for initiating a new payout destination application and listing payout destination applications > > - [POST /v1/accounts/{aid}/management/settings/approvals/payout-destinations](/api-reference/approvals/aid_management_settings_approvals_payout_destinations_post) > - [GET /v1/accounts/{aid}/management/settings/approvals/payout-destinations](/api-reference/approvals/aid_management_settings_approvals_payout_destinations_get) ## 2022-02-01 > Add endpoint for adding Vipps overrides > > - [PUT /v1/accounts/{aid}/management/settings/connections/vipps/overrides](/management-auth-api/account-connections/aid_account_settings_connections_vipps_overrides_put) ## 2021-10-01 > Add endpoints for managing customer due diligence cases > > - [POST /v1/accounts/{aid}/management/settings/cdd/cases](/management-auth-api/account-cdd/aid_management_settings_cdd_cases_post) > - [GET /v1/accounts/{aid}/management/settings/cdd/cases](/management-auth-api/account-cdd/aid_management_settings_cdd_cases_get) ## 2021-06-01 > Add support for configuring SMS MFA for account user > > - [PUT /v1/account/user/mfa/sms](/management-auth-api/account-users/account_user_mfa_sms_put) ## 2021-05-01 > Add support for `phone_number` in `account.company` and `account.billing` > > - [PUT /v1/accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > Add new endpoints for managing Bambora connection > > - [POST /management/settings/connections/bambora](/management-auth-api/account-connections/aid_account_settings_connections_bambora_post) > - [GET /management/settings/connections/bambora](/management-auth-api/account-connections/aid_account_settings_connections_bambora_get) > - [POST /management/settings/connections/bambora/{callback_reference}](/management-auth-api/account-connections/aid_account_settings_connections_bambora_callback_post) ## 2021-04-01 > Add support for `account_manager` > > - [POST /accounts/{oid}/signup](/management-auth-api/account-onboarding/accounts_oid_signup_post) > - [POST /accounts/{oid}/signup/prefill](/management-auth-api/account-onboarding-prefill/accounts_oid_signup_prefill_post) > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > Add support for filter on services and connections. > > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > Extend the Account to support new properties, `progression`, `reseller_id` and `statistics` to services. > > - [GET /v1/accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > - [PUT /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) > - [GET /v1/accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_get) > Add support for account events. > > - [POST /v1/accounts/{oid}/management/accounts/{aid}/events](/management-auth-api/accounts/aid_mgmnt_accounts_events_post) > - [GET /v1/accounts/{oid}/management/accounts/{aid}/events](/management-auth-api/accounts/aid_mgmnt_accounts_events_get) ## 2021-03-01 > Make Swish cert and passphrase not required > > - [POST /v1/accounts/{aid}/management/settings/connections/swish/{callback_reference}](/management-auth-api/account-connections/aid_account_settings_connections_swish_callback_post) > Add support for changing account user password > > - [PUT /v1/accounts/{aid}/account/user/password](/management-auth-api/account-users/account_user_password_put) > Add support for `authorize` when verifying a signup. > > - [POST /v1/accounts/{aid}/signup/verify](/management-auth-api/account-onboarding/accounts_oid_signup_verify_post) ## 2021-02-01 > Document `429 Too Many Requests` response from > > - [POST /v1/accounts/{aid}/auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) > - [POST /v1/accounts/{aid}/auth/passwordless](/management-auth-api/authenticate/aid_auth_account_passwordless_post) > **Break**: Require `ident_type` and `ident` to be include when requesting token > with `grant_type=authorization_code` > > - [POST /v1/accounts/{aid}/auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) > Add support for sending verification code for passwordless login via SMS, and > `session_id={uuid} to resend the same verification code again > Remove unsupported request options,`send=link` and `type=account`. > > - [POST /v1/accounts/{aid}/auth/passwordless](/management-auth-api/authenticate/aid_auth_account_passwordless_post) ## 2021-01-01 > Add support for logging on without MFA even if configured with MFA > > - [POST /v1/accounts/{oid}/auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) > Add support for managing account users scopes with roles. > > - [Roles](#tag/roles) > - [POST /management/users](/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_post) > - [PUT /management/users/{uid}](/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_put) ## 2020-11-01 > Extend the endpoint for getting user accounts to include the accounts > `display_name` and `icon_url`. > > - [GET /account/user](/management-auth-api/account-users/account_user_get) > Add support for account users authenticated by external Identity providers. > External authentication is limited to account users created with > `authentication_type=external`. > > - [POST /management/users](/management-auth-api/account-users/aid_accounts_aid_mgmnt_users_get) > > Following endpoints has been updated to allow Bearer authorization using > ID token issued by external Identity provider. > > - [GET /account/user](/management-auth-api/account-users/account_user_get) > - [POST /auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) > > Account has been updated with `jwks.uri` property that is required to > validate the ID tokens issued by external identity providers. ## 2020-09-01 > Add new endpoint for handling HTTP redirect with ID token query parameter > > - [POST /auth/redirect](/management-auth-api/authenticate/aid_auths_oauth_redirect_post) > Add new endpoint for uploading assets > > - [POST /management/assets](#tag/account-assets) ## 2020-07-01 > Add new endpoints for managing Swish connection > > - [POST /management/settings/connections/swish](/management-auth-api/account-connections/aid_account_settings_connections_swish_post) > - [GET /management/settings/connections/swish](/management-auth-api/account-connections/aid_account_settings_connections_swish_get) > - [POST /management/settings/connections/swish/{callback_reference}](/management-auth-api/account-connections/aid_account_settings_connections_swish_callback_post) ## 2020-05-01 > Extend the AccountCompany with `email` and `technical_email` > > - [PUT /accounts/{aid}/management/settings](/management-auth-api/account-settings/aid_account_settings_put) > - [POST /accounts/{oid}/management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_post) > - [PUT /accounts/{oid}/management/accounts/{aid}](/management-auth-api/accounts/aid_accounts_aid_put) ## 2020-01-31 > Add support for `applicant.agreement.attachments` > > - [POST /accounts/{oid}/signup](http://localhost:8080/management-auth-api/account-onboarding/accounts_oid_signup_post) > > Add support for enabling MFA (OOB) for auth users. > > - [POST /auth/users](/management-auth-api/auth-users/aid_auth_users_post) ## 2019-12-31 > Extend the AccountApplicant with support for > `promo_code` and utm campaign codes. > > - [POST /signup](/management-auth-api/account-onboarding/accounts_oid_signup_post) ## 2019-11-31 > Add support for creating client with description > > - [POST /auth/clients](/management-auth-api/clients/aid_auth_clients_post) ## 2019-09-31 > Extend settings with PayEx connections > > - [GET /management/settings](/management-auth-api/account-settings/aid_account_aid_get) > - [GET /management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) ## 2019-07-31 > Add new endpoints for managing PayEx connection > > - [POST /management/settings/connections/payex/{payment_product_type}](/management-auth-api/account-connections/aid_account_settings_connections_payex_post) > - [GET /management/settings/connections/payex/{payment_product_type}](/management-auth-api/account-connections/aid_account_settings_connections_payex_get) > - [POST /management/settings/connections/payex/{payment_product_type}/{callback_reference}](/management-auth-api/account-connections/aid_account_settings_connections_payex_callback_post) ## 2019-06-31 > The scope required for accessing endpoint has changed, > we will continue to support the old scopes but they was removed from > the documentation > Support `search`, `limit` and `starting_after` query parameter > when listing partner accounts > > - [GET /management/accounts](/management-auth-api/accounts/aid_mgmnt_accounts_get) > Support for issuing exchange token for a sub-account, > to allow partner accounts to manage sub accounts. > > - [POST /auth/impersonate_token](/management-auth-api/authenticate/aid_auths_oauth_exchange_token_post) ## 2019-05-31 > Support for including a Refresh Token when requesting > an Access Token. Use `grant-type=refresh_token` to get an Access Token > from a Refresh Token. > > - [POST /auth/token](/api-reference/authenticate/aid_auths_oauth_token_post) > Support for revoking a Refresh Token > > - [POST /auth/revoke](/management-auth-api/authenticate/aid_auths_oauth_revoke_post) ## 2018-12-17 > Rename typo in Account definition > All `bussiness_name` properties renamed to `business_name` contact: name: API Integration Support email: integration@dintero.com version: LATEST license: name: UNLICENSED url: https://dintero.com servers: - url: https://api.dintero.com/v1 security: - JWT: [] tags: - name: auth users x-displayName: users description: Admin users - name: account users x-displayName: users description: | Admin user for an account. The user is allowed to manage the account and administrate access via client/grants - name: onboarding description: | Onboard a merchant to the Dintero platform - name: account-onboarding x-displayName: account description: | Manage the signup of a new merchant account - name: account-onboarding-prefill x-displayName: account-prefill description: | Manage prefilled signup of a new merchant account - name: account-connections x-displayName: connections description: | Manage setup of account connections to external services - name: account-settings x-displayName: settings description: Manage account settings - name: connection-onboarding x-displayName: connections description: | Manage the setup of a new account connection - name: account-fraud-search x-displayName: searches description: | Search external registers for any issues related to the account - name: account-assets x-displayName: assets description: | Manage account assets - name: account-stores x-displayName: stores description: | Manage account stores - name: account-terminals x-displayName: terminals description: | Manage account terminals - name: account-cdd x-displayName: due diligence description: | Manage account KYC/AML cases - name: approvals x-displayName: approvals description: | Account approval processes - name: price-packages x-displayName: price packages description: Manage price packages for the account - name: payout-destinations x-displayName: payout destinations description: | Payout destinations - name: payout-instructions x-displayName: payout instructions description: | A payout instruction is owned by and entity and instructs how payout will be done to the entity The instructions includes information about transfer instruments is enabled and what transfer instruments to use given a specific payout currency - name: account-price-package x-displayName: price package description: Manage price package on the account paths: /accounts/{aid}/compliance-search/match: post: tags: - account-fraud-search summary: accounts_aid_search_match_post description: > Search the MATCH register for any potential matches related to fraud for the account scopes: - read:accounts:/match operationId: accounts_aid_search_match_post parameters: - $ref: '#/components/parameters/accountId' - name: limit in: query description: | A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 20 items. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: starting_after in: query description: > Zero-based offset to start from. A value of 10 will start with the 11th item schema: type: integer minimum: 0 requestBody: content: application/json: schema: $ref: '#/components/schemas/MatchTerminationRequest' required: true responses: '200': $ref: '#/components/responses/MatchSearch' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/AccessForbidden' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/ServerError' security: - JWT: [] components: parameters: accountId: name: aid description: | An id that uniquely identifies the account. in: path required: true schema: type: string format: ^[PT]{1}\d{8}$ minLength: 9 maxLength: 9 schemas: MatchTerminationRequest: type: object properties: merchant: $ref: '#/components/schemas/MatchRequestMerchant' search_criteria: $ref: '#/components/schemas/MatchRequestSearchCriteria' required: - merchant - search_criteria MatchRequestMerchant: type: object properties: business_name: type: string description: The name of the business assigned by the principal owner(s) minLength: 1 maxLength: 60 trade_name: type: string description: >- The name used by a merchant that could be different from the legal name of the business maxLength: 110 website_url: type: string description: URL to website of business maxLength: 4000 address: $ref: '#/components/schemas/MatchRequestAddress' principals: $ref: '#/components/schemas/MatchRequestPrincipal' phone_number: type: string description: >- The Business or Merchant's phone number. Should not contain country code and should be digits only maxLength: 25 merchant_category: type: string minLength: 1 maxLength: 4 description: | A classification code used in authorization, clearing, and other transactions or reports to identify the type of merchant. example: '1234' required: - business_name - principals - address - phone_number - merchant_category MatchRequestSearchCriteria: required: - search_all type: object properties: search_all: type: string description: > Determines if the inquiry is worldwide or not. The inquiry request can be either worldwide or regions and/or countries based. It cannot be both. If it is not worldwide search (search_all = N) and if both region and country are not specified, then search will happen for USA. Valid values are Y or N region: type: array description: | Region in which the inquiry results must be obtained. (1) - U.S. REGION; (A) - CANADA; (B) - CARIB,C AMERICA,MEX,S AMERICA; (C) - ASIA/PACIFIC; (D) - EUROPE; (E) - SOUTH ASIA MIDDLE EAST AFRICA; A maximum of 6 regions may be submitted. items: type: string example: - '1' - A - D country: type: array description: > The three digit country code of the principal owner. Valid values are three digit alpha country codes as defined in ISO 3166-1 (See https://en.wikipedia.org/wiki/ISO_3166-1) items: type: string example: - NOR - USA - CAN MatchSearchResponse: type: object properties: starting_after: type: integer description: > cursor for use in pagination. starting_after is the zero-based index to start the next request after. For instance, if you send a request that starts at index 0 and returns 10 items, a subsequent call can include starting_after=10 in order to fetch items starting with item 11. If there are no more items this field is not returned. inquiry_reference_number: type: string description: Reference number to look up inquiry result possible_matches: type: array items: type: object properties: total_merchant_matches: type: number description: Total number of possible matches on terminated merchants terminated_merchants: type: array items: type: object properties: merchant: $ref: '#/components/schemas/MatchMerchant' merchant_match: $ref: '#/components/schemas/MatchMerchantMatch' Error: type: object required: - error properties: error: type: object required: - message properties: code: type: string description: The code used to identify the error/warning errors: type: array description: The nested error(s) encountered during validation items: type: object message: type: string description: The human readable description of the error/warning MatchRequestAddress: type: object properties: address_line: type: string description: First line of the address, usually includes street name and number minLength: 1 maxLength: 60 address_line_2: type: string description: >- Second line of the address, usually includes apartment number or suite number maxLength: 60 city: type: string description: The name of the city for a merchant location minLength: 1 maxLength: 40 postal_code: type: string description: The postal code for a merchant location minLength: 1 maxLength: 10 country: type: string description: > The country in which the address resides. \ Valid values are three digit alpha country codes as defined in ISO 3166-1 (See https://en.wikipedia.org/wiki/ISO_3166-1) minLength: 1 maxLength: 3 required: - address_line - city - postal_code - country MatchRequestPrincipal: type: array description: List of ultimate beneficial owners minItems: 1 maxItems: 5 items: type: object required: - first_name - last_name - email - phone_number - address properties: first_name: type: string description: The first name of the principal owner of the business minLength: 1 maxLength: 40 last_name: type: string description: The last name of the principal owner of the business minLength: 1 maxLength: 40 email: type: string description: Email Id of a principal. example: abc@xxx.com minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9!#$&*+/\?`@{|}~^.\-]+(\.com|\.net|\.org|\.edu)?$ phone_number: type: string description: > The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: '3165557625' minLength: 1 maxLength: 25 pattern: ^[0-9]+$ date_of_birth: type: string description: | The date of birth of the principal owner. Format: YYYY-MM-DD example: ‘1980-01-01’ format: date address: type: object required: - address_line - city - country properties: address_line: type: string description: >- First line of the address, usually includes street name and number minLength: 1 maxLength: 60 address_line_2: type: string description: >- Second line of the address, usually includes apartment number or suite number maxLength: 60 city: type: string description: The name of the city for a merchant location minLength: 1 maxLength: 40 postal_code: type: string description: The postal code for a merchant location minLength: 1 maxLength: 10 country: type: string description: > The country in which the address resides. \ Valid values are three digit alpha country codes as defined in ISO 3166-1 (See https://en.wikipedia.org/wiki/ISO_3166-1) minLength: 1 maxLength: 3 MatchMerchant: type: object properties: name: type: string description: The name of the business assigned by the principal owner(s) minLength: 1 maxLength: 60 doing_business_as_name: type: string description: >- The name used by a merchant that could be different from the legal name of the business maxLength: 110 address: $ref: '#/components/schemas/MatchAddress' phone_number: type: string description: >- The Business or Merchant's phone number. Should not contain country code and should be digits only maxLength: 25 alt_phone_number: type: string description: The Business or Merchant's alternate phone number maxLength: 25 national_tax_id: type: string description: The Merchant national tax ID (only provided in the US and is masked) maxLength: 35 country_subdivision_tax_id: type: string description: >- The Merchant Country Subdivision tax ID (only provided in the US and is masked) maxLength: 35 urls: type: array description: Website addresses of the merchant items: type: string maxLength: 4000 principals: $ref: '#/components/schemas/MatchPrincipal' added_on_date: type: string description: Date the merchant was added to the MATCH database (ISO 8601 format). example: '2024-01-17' termination_reason_code: $ref: '#/components/schemas/MatchTerminationReason' added_by_acquirer_id: type: string description: The Member ICA that has added the merchant to the MATCH system maxLength: 11 url_groups: type: array items: $ref: '#/components/schemas/MatchUrlGroup' comments: type: string description: Brief comments on why Merchant is added example: Added for reasons of fraud maxLength: 500 MatchMerchantMatch: type: object description: > Object showing which field in the merchant data that matched the inquiry. Each field has a string value of M00, M01 or M02. M00 - No match for the given field M01 - Exact match for the given field M02 - Phonetic match for the given field A phonetic match can happen for words that sound similar (e.g. easy and EZ) or minor typographical differences, such as Rob and Bob properties: name: type: string doing_business_as_name: type: string phone_number: type: string address: type: string alt_phone_number: type: string country_subdivision_tax_id: type: string national_tax_id: type: string principal_matches: type: array items: $ref: '#/components/schemas/MatchPrincipalMatch' MatchAddress: type: object properties: address_line_one: type: string description: First line of the address, usually includes street name and number minLength: 1 maxLength: 60 address_line_two: type: string description: >- Second line of the address, usually includes apartment number or suite number maxLength: 60 city: type: string description: The name of the city for a merchant location. minLength: 1 maxLength: 40 country_subdivision: type: string description: >- The abbreviated state or province code for a merchant location (only supported for US and Canada merchants). maxLength: 2 province: type: string description: The name of the province for the location. maxLength: 3 postal_code: type: string description: The postal code for a merchant location minLength: 1 maxLength: 10 country: type: string description: >- The country in which the address resides. Valid values are three digit alpha country codes as defined in ISO 3166-1 (See https://en.wikipedia.org/wiki/ISO_3166-1) minLength: 1 maxLength: 3 MatchPrincipal: type: array items: type: object properties: first_name: type: string description: The first name of the principal owner of the business. minLength: 1 maxLength: 40 middle_initial: type: string description: >- The middle initial of the name of the principal owner of the business. last_name: type: string description: The last name of the principal owner of the business. minLength: 1 maxLength: 40 address: $ref: '#/components/schemas/MatchAddress' phone_number: type: string description: >- The Business or Merchant's phone number. Should not contain country code and should be digits only maxLength: 25 email: type: string description: Email Id of a principal owner of the business. alt_phone_number: type: string description: The Business or Merchant's alternate phone number maxLength: 25 national_id: type: string description: >- The Social Security number of a principal owner. If the principal owner is not from the U.S. Region, then use their national ID card number. maxLength: 35 drivers_license: $ref: '#/components/schemas/MatchDriversLicense' MatchTerminationReason: type: string example: '13' enum: - '01' - '02' - '03' - '04' - '05' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' description: > A two digit numeric code indication why a particular merchant was terminated. * 01 - Account Data Compromise * 02 - Common Points of Purchase * 03 - Laundering * 04 - Excessive Chargebacks * 05 - Excessive Fraud * 06 - Reserved for Future Use * 07 - Fraud Conviction * 08 - MasterCard Questionable Merchant Audit Program * 09 - Bankruptcy/Liquidation/Insolvency * 10 - Violation of MasterCard Standards * 11 - Merchant collusion * 12 - PCI Data Security Standard, Noncompliance * 13 - Illegal Transactions * 14 - Identity Theft MatchUrlGroup: type: object properties: exact_match_urls: $ref: '#/components/schemas/MatchUrl' close_match_urls: $ref: '#/components/schemas/MatchUrl' no_match_urls: $ref: '#/components/schemas/MatchUrl' MatchPrincipalMatch: type: object properties: name: type: string address: type: string phone_number: type: string alt_phone_number: type: string national_id: type: string drivers_license: type: string email: type: string date_of_birth: type: string MatchDriversLicense: type: object properties: number: type: string description: >- The drivers license number of a principal owner. Required when Drivers License Country is provided. Should not be provided if Drivers License Country is not provided. maxLength: 25 country_subdivision: type: string description: >- The abbreviated state or province code for a merchant location (only supported for US and Canada merchants). Required when Drivers License Country is 'USA'. Should not be provided for non-US Drivers License Country. maxLength: 2 country: type: string description: >- The three digit country code of the principal owner. Valid values are three digit alpha country codes as defined in ISO 3166-1. Required when Drivers License Number is provided. Should not be provided if Drivers License Number is not provided. maxLength: 3 MatchUrl: type: object properties: urls: type: array items: type: string maxLength: 4000 responses: MatchSearch: description: Possible merchant matches from MATCH content: application/json: schema: $ref: '#/components/schemas/MatchSearchResponse' BadRequest: description: Bad / Invalid request content: application/json: schema: $ref: '#/components/schemas/Error' AccessForbidden: description: Access forbidden, invalid JWT token was used content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' ServerError: description: Unexpected Error content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: JWT: type: http description: > Bearer authentication (token authentication) should be used for accessing the API. Use [Get Token](/api-reference/authenticate/aid_auths_oauth_token_post) to get an access token for client credentials. Pass the token in the request header: Authorization: Bearer {access_token} where the **access_token** is JSON Web Tokens (JWT). scheme: bearer bearerFormat: JWT ````