--- updatedAt: 2026-09-29T08:03:54.000Z agentTools: projectIndex: https://docs.sumsub.com/llms.txt --- # Get Bank Account and Penny Drop Verification details # Overview Use this method to get the results of [Bank Account Verification](https://docs.sumsub.com/sumsub/docs/bank-account-verification) or [Penny Drop Verification](https://docs.sumsub.com/sumsub/docs/penny-drop-verification). ## Required permissions To use this method, your [app token](https://docs.sumsub.com/sumsub/docs/app-tokens) must have the **View check results** [permission](https://docs.sumsub.com/sumsub/docs/user-roles#permissions). # Request example ```curl curl -X GET \ 'https://api.sumsub.com/resources/checks/latest?applicantId=67346d0623c63349989d00bb&type=BANK_DETAILS_CHECK' \ -H 'accept: application/json' \ -H 'X-App-Token: ' \ -H 'X-App-Access-Sig: ' \ -H 'X-App-Access-Ts: ' ``` # Response explained The response represents a singleton list of checks. ## Root variables The root variables are the core `BANK_DETAILS_CHECK` check result data items. Some of them may include nested attributes and element fields. | Field | Type | Description | | :--------------------- | :----------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `answer` | String | Check answer:
  • GREEN — user verification is successfully completed.
  • YELLOW — user verification is currently in progress.
  • RED — user has not passed verification and is rejected.
  • ERROR — user verification is not completed because the service is currently unavailable.
| | `checkType` | String | Indicates that it is a `BANK_DETAILS_CHECK` check type. | | `createdAt` | Date | Date and time (UTC, format `YYYY-DD-MM HH:MM:SS`) of the latest `BANK_DETAILS_CHECK` check result. | | `id` | String | Unique identifier of the check. | | `inputDoc` | [Object](#inputdoc-attributes) | Represents the data used for the `BANK_DETAILS_CHECK` check. | | `extractedDoc` | [Object](#extracteddoc-attributes) | External check source data. It may not be present if the data is not received. | | `bankDetailsCheckInfo` | [Object](#bankdetailscheckinfo-attributes) | Includes `BANK_DETAILS_CHECK` check results. | | `ekycCheckInfo` | [Object](#ekyccheckinfo-attributes) | Non-Doc verification information. | | `violations` | Array of strings | Indicates violations that were found:
  • PERSON\_IS\_MINOR — account holder is minor.
| ## `inputDoc` attributes | Field | Type | Description | | :---------- | :----- | :------------------------------------------------------------------------------ | | `idDocType` | String | Type of the document provided for verification (`PROOF_OF_PAYMENT` or `OTHER`). | | `country` | String | Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on). | ## `extractedDoc` attributes | Field | Type | Description | | ------------------ | ---------------- | ------------------------------------------------------ | | `firstName` | String | Applicant first name. | | `additionalFields` | Array of objects | Represents additional information about the applicant. | ## `ekycCheckInfo` attributes | Field | Type | Description | | :----------------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `country` | String | Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on). | | `confirmationId` | String | Confirmation identifier for `oAuth` verification. | | `confirmationType` | String | Confirmation type:
  • otp — Submission should be confirmed via OTP code.
  • oAuth — Applicant should be directed to the external service to proceed with submission.
| ## `bankDetailsCheckInfo` attributes | Field | Type | Description | | :--------------- | :----------------------------------- | :------------------------------------------------------------------------------------------ | | `accountDetails` | [Object](#accountdetails-attributes) | Includes the objects representing the sender details. | | `transferInfo` | [Object](#transferInfo-attributes) | Includes the objects representing the transfer information, refund and beneficiary details. | ## `accountDetails` attributes | Field | Type | Description | | :--------------- | :----------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `personFullName` | String | Sender full name. | | `legalAge` | Boolean | Specifies whether the account holder is of legal age or is a minor:
  • true — account holder is of legal age.
  • false — account holder is minor.
| | `iban` | String | Sender IBAN. | | `accountType` | String | Type of the account. Return the code aligned with the ISO 20022:
  • CACC — Current account. Account used to post debits and credits when no specific account has been nominated.
  • CARD — Card account. Account used for credit card payments.
  • CASH — Cash payment. Account used for the payment of cash.
  • LOAN — Loan. Account used for loans.
  • SVGS — Savings. Account used for savings.
  • OTHR — Other. Account not otherwise specified.
| | `bankName` | String | Sender Bank name. | | `bankBranchName` | String | Sender Bank branch name. | | `bic` | String | Sender Bank BIC. | | `country` | String | Sender Bank country. Presented as an alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on). | | `creditLimit` | [Object](#creditlimit-attributes) | Credit limit of the account. | | `balanceDetails` | [Object](#balancedetails-attributes) | Account balance details. | ## `creditLimit` attributes | Field | Type | Description | | :--------- | :----- | :------------------------------------------------------------------------ | | `amount` | Double | Credit limit amount (for example, `10000.0`). | | `currency` | String | Currency of the amount, returned as a ISO 4217 code (for example, `EUR`). | ## `balanceDetails` attributes | Field | Type | Description | | :-------------------- | :-------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `moneyAmount` | [Object](#moneyamount-attributes) | Balance amount and currency. | | `balanceType` | String | Account balance type, returned as the code following the ISO 20022 standard:
  • CLAV — Closing available. Closing balance of amount of money that is at the disposal of the account owner on the date specified.
  • CLBD — Closing booked. Balance of the account at the end of the pre-agreed account reporting period.
  • FWAV — Forward available. Forward available balance of money that is at the disposal of the account owner on the date specified.
  • INFO — Information. Balance for informational purposes.
  • ITAV — Interim available. Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day.
  • ITBD — Interim booked. Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day.
  • OPAV — Opening available. Opening balance of amount of money that is at the disposal of the account owner on the date specified.
  • OPBD — Opening booked. Book balance of the account at the beginning of the account reporting period.
  • PRCD — Previously closed booked. Balance of the account at the previously closed account reporting period.
  • XPCD — Expected (instant) balance.
  • VALU — Value-date balance.
  • OTHR — Other balance.
| | `lastTransactionDate` | Date | Date and time (UTC, format `YYYY-DD-MM HH:MM:SS`) of the last transaction. | ## `moneyAmount` attributes | Field | Type | Description | | :--------- | :----- | :---------------------------------------------------------------------- | | `amount` | Double | Credit limit amount (for example, `10000.0`). | | `currency` | String | Currency of the amount, returned as ISO 4217 code (for example, `EUR`). | ## `transferInfo` attributes | Field | Type | Description | | :------------------- | :--------------------------------------- | :----------------------------------------------------------------- | | `transferDetails` | [Object](#transferdetails-attributes) | Includes the objects representing the transfer and refund details. | | `beneficiaryDetails` | [Object](#beneficiarydetails-attributes) | Includes the objects representing the beneficiary details. | ## `transferDetails` attributes
Field Type Description
`paymentId` String Unique identifier of the payment.
`reference` String Unique reference for the payment from the merchant.
`createdAt` Date Date and time (UTC, format `YYYY-DD-MM HH:MM:SS`) of the payment.
`amount` Integer Payment amount.
`currency` String Payment currency code, for example, `EUR`.
`status` String Payment status:
  • PENDING
  • FAILED
  • RECEIVED
  • UNKNOWN
`originalStatus` String Detailed payment status: - `BANK_REDIRECT` - `DELAYED_AT_BANK` - `AWAITING_CHECKOUT_AUTHORIZATION` - `ADDITIONAL_AUTHORIZATION_REQUIRED` - `COMPLETED` - `APPROVED_BY_RISK` - `REFUSED_BY_RISK` - `REFUSED_BY_BANK` - `ERROR_AT_BANK` - `AUTHORISED_BY_USER` - `CANCELLED_BY_USER` - `ABANDONED_BY_USER` - `FAILED` - `NOT_RECEIVED` - `RECEIVED` - `UNKNOWN`
`type` String Transaction type: `OTHER`.
`refundStatus` String Refund status (returned only if the Penny Drop Refund feature is enabled for your account):
  • CREATED
  • PROCESSING
  • REJECTED
  • COMPLETED
  • FAILED
  • UNKNOWN
`originalRefundStatus` String Refund status (returned only if the Penny Drop Refund feature is enabled for your account):
  • REFUND_CREATED
  • REFUND_APPROVED
  • REFUND_PROCESSING
  • REFUND_REJECTED
  • REFUND_CONFIRMED
  • REFUND_FAILED
  • UNKNOWN
`refundReference` String Unique identifier of the created refund.
## `beneficiaryDetails` attributes | Field | Type | Description | | :--------------- | :----- | :------------------------------------------------------------------------------------------------------------ | | `personFullName` | String | Beneficiary full name. | | `iban` | String | Beneficiary IBAN. | | `bic` | String | Beneficiary Bank BIC. | | `country` | String | Beneficiary Bank country. Presented as an alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on). | # Response examples ## Penny Drop (PD) verification response examples If the request is successfully sent and processed, you will get a response with one of the following answers: * `GREEN` — verification is successfully completed. * `YELLOW` — verification is currently in progress. * `ERROR` — verification is not completed because the service is currently unavailable. ```json GREEN { "checks": [ { "answer": "GREEN", "checkType": "BANK_DETAILS_CHECK", "createdAt": "2025-03-09 19:25:07", "id": "aa3b1641-cf91-4d19-95e1-62d30d7f401a", "inputDoc": { "idDocType": "PROOF_OF_PAYMENT", "country": "DEU" }, "extractedDoc": { "firstName": "Jane Doe", "additionalFields": [ { "name": "bank", "value": "Volt Mock Bank" } ] }, "ekycCheckInfo": { "confirmationId": "oOp4x5Rm72yeFOx3kfs5FCFv", "confirmationType": "oAuth" }, "bankDetailsCheckInfo": { "accountDetails": { "personFullName": "Jane Doe", "iban": "DE53500105177415947516", "bankName": "Volt Mock Bank", "bankBranchName": "Volt Mock Bank", "bic": "COBADEFF", "country": "DEU" }, "transferInfo": { "transferDetails": { "paymentId": "7356dafb-67e2-473c-acb7-baa9d3fd7736", "reference": "PNLykibtDB", "createdAt": "2025-03-09 19:24:35", "amount": 0.1, "currency": "EUR", "status": "RECEIVED", "originalStatus": "RECEIVED", "type": "OTHER", "refundStatus": "COMPLETED", "originalRefundStatus": "REFUND_CONFIRMED", "refundReference": "026cefa0-a174-4ca3-a1e6-533a129d9c32" }, "beneficiaryDetails": { "personFullName": "Raritex Trade Ltd", "iban": "DE89370400440532013000", "bic": "COBADEFF", "country": "DEU" } } } } ] } ``` ```json YELLOW { "checks" : [ { "answer" : "YELLOW", "checkType" : "BANK_DETAILS_CHECK", "createdAt" : "2025-02-06 09:50:47", "id" : "5e5eeaca-3ec0-450b-ad4f-5121813cd096", "inputDoc" : { "idDocType" : "PROOF_OF_PAYMENT", "country" : "DNK" }, "ekycCheckInfo" : { "confirmationId" : "Fip2DKtUbkSSuLBmOzpyfAHi", "confirmationType" : "oAuth" } } ] } ``` ```json ERROR { "checks" : [ { "answer" : "ERROR", "checkType" : "BANK_DETAILS_CHECK", "createdAt" : "2025-02-05 12:46:04", "id" : "6bf059dc-03d6-4c4c-96d6-d4fec6245def", "inputDoc" : { "idDocType" : "PROOF_OF_PAYMENT", "country" : "DEU" }, "ekycCheckInfo" : { } } ] } ``` ## Bank Account Verification (BAV) response examples If the request is successfully sent and processed, you will get a response with one of the following answers: * `GREEN` — applicant has successfully passed verification. * `YELLOW` — applicant verification is currently in progress. * `RED` — applicant has not passed verification and was rejected. * `ERROR` — applicant verification was not completed because the service is currently unavailable. ```json GREEN { "checks": [ { "answer": "GREEN", "checkType": "BANK_DETAILS_CHECK", "createdAt": "2025-05-18 19:20:59", "id": "34fbc1c8-164d-4bcf-b085-7f0323b2e0cf", "inputDoc": { "idDocType": "OTHER", "country": "FIN" }, "extractedDoc": { "country": "FIN", "firstName": "Mikko Virtanen" }, "ekycCheckInfo": { "confirmationId": "st8KmCZMPXog2SnTR75vDLs3", "confirmationType": "oAuth" }, "bankDetailsCheckInfo": { "accountDetails": { "personFullName": "Mikko Virtanen", "legalAge": true, "iban": "FI3012345600000785", "accountType": "CACC", "creditLimit": { "amount": 10000.0, "currency": "EUR" }, "bankName": "S-Pankki", "bic": "SPANKFIHXXX", "country": "FIN", "balanceDetails": { "moneyAmount": { "amount": 3000.0, "currency": "EUR" }, "balanceType": "CLAV", "lastTransactionDate": "2025-05-18 19:20:59" } } } } ] } ``` ```json YELLOW { "checks": [ { "answer": "YELLOW", "checkType": "BANK_DETAILS_CHECK", "createdAt": "2025-06-18 09:20:35", "id": "e7b3b71f-5278-4e63-ba17-377377779b0b", "inputDoc": { "idDocType": "OTHER", "country": "FIN" }, "ekycCheckInfo": { "confirmationId": "u8M2pnx58JHSCthoSC1o7yu1", "confirmationType": "options" } } ] } ``` ```json RED { "checks": [ { "answer": "RED", "checkType": "BANK_DETAILS_CHECK", "createdAt": "2025-05-18 19:20:59", "id": "34fbc1c8-164d-4bcf-b085-7f0323b2e0cf", "inputDoc": { "idDocType": "OTHER", "country": "FIN" }, "extractedDoc": { "country": "FIN", "firstName": "Mikko Virtanen" }, "ekycCheckInfo": { "confirmationId": "st8KmCZMPXog2SnTR75vDLs3", "confirmationType": "oAuth" }, "bankDetailsCheckInfo": { "accountDetails": { "personFullName": "Mikko Virtanen", "legalAge": false, "iban": "FI3012345600000785", "accountType": "CACC", "creditLimit": { "amount": 10000.0, "currency": "EUR" }, "bankName": "S-Pankki", "bic": "SPANKFIHXXX", "country": "FIN", "balanceDetails": { "moneyAmount": { "amount": 3000.0, "currency": "EUR" }, "balanceType": "CLAV", "lastTransactionDate": "2025-05-18 19:20:59" } } }, "violations": [ "PERSON_IS_MINOR" ] } ] } ``` ```json ERROR { "checks": [ { "answer": "ERROR", "checkType": "BANK_DETAILS_CHECK", "createdAt": "2025-02-05 12:46:04", "id": "6bf059dc-03d6-4c4c-96d6-d4fec6245def", "inputDoc": { "idDocType": "OTHER", "country": "FIN" }, "ekycCheckInfo": {} } ] } ``` ## Failed request example If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example: ```json { "description": "Applicant with id 67346775989cba6a82b621de not found", "code": 404, "correlationId": "3b156dad5a2dfe4bec2485b2039f7e64" } ``` # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "sumsub-api", "version": "1.0" }, "servers": [ { "url": "https://api.sumsub.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "X-App-Token", "in": "header", "x-default": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/resources/checks/latest?type=BANK_DETAILS_CHECK": { "get": { "summary": "Get Bank Account and Penny Drop Verification details", "description": "", "operationId": "get-bank-verification-details", "parameters": [ { "name": "applicantId", "in": "query", "description": "Unique identifier of the applicant in the Sumsub system.

This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the [Dashboard](https://cockpit.sumsub.com/checkus/#/applicants/individual?limit=10&page=0).

If the `applicantId` is unknown to you, use the [Get applicant data (externalUserId)](https://docs.sumsub.com/sumsub/reference/get-applicant-data-via-externaluserid) method to fetch it.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "GREEN (PD) — Applicant passed verification": { "value": "{\n \"checks\": [\n {\n \"answer\": \"GREEN\",\n \"checkType\": \"BANK_DETAILS_CHECK\",\n \"createdAt\": \"2025-03-09 19:25:07\",\n \"id\": \"aa3b1641-cf91-4d19-95e1-62d30d7f401a\",\n \"inputDoc\": {\n \"idDocType\": \"PROOF_OF_PAYMENT\",\n \"country\": \"DEU\"\n },\n \"extractedDoc\": {\n \"firstName\": \"Jane Doe\",\n \"additionalFields\": [\n {\n \"name\": \"bank\",\n \"value\": \"Volt Mock Bank\"\n }\n ]\n },\n \"ekycCheckInfo\": {\n \"confirmationId\": \"oOp4x5Rm72yeFOx3kfs5FCFv\",\n \"confirmationType\": \"oAuth\"\n },\n \"bankDetailsCheckInfo\": {\n \"accountDetails\": {\n \"personFullName\": \"Jane Doe\",\n \"iban\": \"DE53500105177415947516\",\n \"bankName\": \"Volt Mock Bank\",\n \"bankBranchName\": \"Volt Mock Bank\",\n \"bic\": \"COBADEFF\",\n \"country\": \"DEU\"\n },\n \"transferInfo\": {\n \"transferDetails\": {\n \"paymentId\": \"7356dafb-67e2-473c-acb7-baa9d3fd7736\",\n \"reference\": \"PNLykibtDB\",\n \"createdAt\": \"2025-03-09 19:24:35\",\n \"amount\": 0.1,\n \"currency\": \"EUR\",\n \"status\": \"RECEIVED\",\n \"originalStatus\": \"RECEIVED\",\n \"type\": \"OTHER\",\n \"refundStatus\": \"COMPLETED\",\n \"originalRefundStatus\": \"REFUND_CONFIRMED\",\n \"refundReference\": \"026cefa0-a174-4ca3-a1e6-533a129d9c32\"\n },\n \"beneficiaryDetails\": {\n \"personFullName\": \"Raritex Trade Ltd\",\n \"iban\": \"DE89370400440532013000\",\n \"bic\": \"COBADEFF\",\n \"country\": \"DEU\"\n }\n }\n }\n }\n ]\n}" }, "YELLOW (PD) — verification in progress": { "value": "{\n \"checks\" : [ {\n \"answer\" : \"YELLOW\",\n \"checkType\" : \"BANK_DETAILS_CHECK\",\n \"createdAt\" : \"2025-02-06 09:50:47\",\n \"id\" : \"5e5eeaca-3ec0-450b-ad4f-5121813cd096\",\n \"inputDoc\" : {\n \"idDocType\" : \"PROOF_OF_PAYMENT\",\n \"country\" : \"DNK\"\n },\n \"ekycCheckInfo\" : {\n \"confirmationId\" : \"Fip2DKtUbkSSuLBmOzpyfAHi\",\n \"confirmationType\" : \"oAuth\"\n }\n } ]\n}" }, "ERROR (PD) — service unavailable": { "value": "{\n \"checks\" : [ {\n \"answer\" : \"ERROR\",\n \"checkType\" : \"BANK_DETAILS_CHECK\",\n \"createdAt\" : \"2025-02-05 12:46:04\",\n \"id\" : \"6bf059dc-03d6-4c4c-96d6-d4fec6245def\",\n \"inputDoc\" : {\n \"idDocType\" : \"PROOF_OF_PAYMENT\",\n \"country\" : \"DEU\"\n },\n \"ekycCheckInfo\" : { }\n } ]\n}" }, "GREEN (BAV) — applicant passed verification": { "value": "{\n \"checks\": [\n {\n \"answer\": \"GREEN\",\n \"checkType\": \"BANK_DETAILS_CHECK\",\n \"createdAt\": \"2025-05-18 19:20:59\",\n \"id\": \"34fbc1c8-164d-4bcf-b085-7f0323b2e0cf\",\n \"inputDoc\": {\n \"idDocType\": \"OTHER\",\n \"country\": \"FIN\"\n },\n \"extractedDoc\": {\n \"country\": \"FIN\",\n \"firstName\": \"Mikko Virtanen\"\n },\n \"ekycCheckInfo\": {\n \"confirmationId\": \"st8KmCZMPXog2SnTR75vDLs3\",\n \"confirmationType\": \"oAuth\"\n },\n \"bankDetailsCheckInfo\": {\n \"accountDetails\": {\n \"personFullName\": \"Mikko Virtanen\",\n \"legalAge\": true,\n \"iban\": \"FI3012345600000785\",\n \"accountType\": \"CACC\",\n \"creditLimit\": {\n \"amount\": 10000.0,\n \"currency\": \"EUR\"\n },\n \"bankName\": \"S-Pankki\",\n \"bic\": \"SPANKFIHXXX\",\n \"country\": \"FIN\",\n \"balanceDetails\": {\n \"moneyAmount\": {\n \"amount\": 3000.0,\n \"currency\": \"EUR\"\n },\n \"balanceType\": \"CLAV\",\n \"lastTransactionDate\": \"2025-05-18 19:20:59\"\n }\n }\n }\n }\n ]\n}" }, "YELLOW (BAV) — verification in progress": { "value": "{\n \"checks\": [\n {\n \"answer\": \"YELLOW\",\n \"checkType\": \"BANK_DETAILS_CHECK\",\n \"createdAt\": \"2025-06-18 09:20:35\",\n \"id\": \"e7b3b71f-5278-4e63-ba17-377377779b0b\",\n \"inputDoc\": {\n \"idDocType\": \"OTHER\",\n \"country\": \"FIN\"\n },\n \"ekycCheckInfo\": {\n \"confirmationId\": \"u8M2pnx58JHSCthoSC1o7yu1\",\n \"confirmationType\": \"options\"\n }\n }\n ]\n}" }, "RED (BAV) — applicant rejected": { "value": "{\n \"checks\": [\n {\n \"answer\": \"RED\",\n \"checkType\": \"BANK_DETAILS_CHECK\",\n \"createdAt\": \"2025-05-18 19:20:59\",\n \"id\": \"34fbc1c8-164d-4bcf-b085-7f0323b2e0cf\",\n \"inputDoc\": {\n \"idDocType\": \"OTHER\",\n \"country\": \"FIN\"\n },\n \"extractedDoc\": {\n \"country\": \"FIN\",\n \"firstName\": \"Mikko Virtanen\"\n },\n \"ekycCheckInfo\": {\n \"confirmationId\": \"st8KmCZMPXog2SnTR75vDLs3\",\n \"confirmationType\": \"oAuth\"\n },\n \"bankDetailsCheckInfo\": {\n \"accountDetails\": {\n \"personFullName\": \"Mikko Virtanen\",\n \"legalAge\": false,\n \"iban\": \"FI3012345600000785\",\n \"accountType\": \"CACC\",\n \"creditLimit\": {\n \"amount\": 10000.0,\n \"currency\": \"EUR\"\n },\n \"bankName\": \"S-Pankki\",\n \"bic\": \"SPANKFIHXXX\",\n \"country\": \"FIN\",\n \"balanceDetails\": {\n \"moneyAmount\": {\n \"amount\": 3000.0,\n \"currency\": \"EUR\"\n },\n \"balanceType\": \"CLAV\",\n \"lastTransactionDate\": \"2025-05-18 19:20:59\"\n }\n }\n },\n \"violations\": [\n \"PERSON_IS_MINOR\"\n ]\n }\n ]\n}" }, "ERROR (BAV) — service unavailable": { "value": "{\n \"checks\": [\n {\n \"answer\": \"ERROR\",\n \"checkType\": \"BANK_DETAILS_CHECK\",\n \"createdAt\": \"2025-02-05 12:46:04\",\n \"id\": \"6bf059dc-03d6-4c4c-96d6-d4fec6245def\",\n \"inputDoc\": {\n \"idDocType\": \"OTHER\",\n \"country\": \"FIN\"\n },\n \"ekycCheckInfo\": {}\n }\n ]\n}" } }, "schema": { "oneOf": [ { "title": "GREEN (PD) — Applicant passed verification", "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "answer": { "type": "string", "example": "GREEN" }, "checkType": { "type": "string", "example": "BANK_DETAILS_CHECK" }, "createdAt": { "type": "string", "example": "2025-03-09 19:25:07" }, "id": { "type": "string", "example": "aa3b1641-cf91-4d19-95e1-62d30d7f401a" }, "inputDoc": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "PROOF_OF_PAYMENT" }, "country": { "type": "string", "example": "DEU" } } }, "extractedDoc": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Jane Doe" }, "additionalFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "bank" }, "value": { "type": "string", "example": "Volt Mock Bank" } } } } } }, "ekycCheckInfo": { "type": "object", "properties": { "confirmationId": { "type": "string", "example": "oOp4x5Rm72yeFOx3kfs5FCFv" }, "confirmationType": { "type": "string", "example": "oAuth" } } }, "bankDetailsCheckInfo": { "type": "object", "properties": { "accountDetails": { "type": "object", "properties": { "personFullName": { "type": "string", "example": "Jane Doe" }, "iban": { "type": "string", "example": "DE53500105177415947516" }, "bankName": { "type": "string", "example": "Volt Mock Bank" }, "bankBranchName": { "type": "string", "example": "Volt Mock Bank" }, "bic": { "type": "string", "example": "COBADEFF" }, "country": { "type": "string", "example": "DEU" } } }, "transferInfo": { "type": "object", "properties": { "transferDetails": { "type": "object", "properties": { "paymentId": { "type": "string", "example": "7356dafb-67e2-473c-acb7-baa9d3fd7736" }, "reference": { "type": "string", "example": "PNLykibtDB" }, "createdAt": { "type": "string", "example": "2025-03-09 19:24:35" }, "amount": { "type": "number", "example": 0.1, "default": 0 }, "currency": { "type": "string", "example": "EUR" }, "status": { "type": "string", "example": "RECEIVED" }, "originalStatus": { "type": "string", "example": "RECEIVED" }, "type": { "type": "string", "example": "OTHER" }, "refundStatus": { "type": "string", "example": "COMPLETED" }, "originalRefundStatus": { "type": "string", "example": "REFUND_CONFIRMED" }, "refundReference": { "type": "string", "example": "026cefa0-a174-4ca3-a1e6-533a129d9c32" } } }, "beneficiaryDetails": { "type": "object", "properties": { "personFullName": { "type": "string", "example": "Raritex Trade Ltd" }, "iban": { "type": "string", "example": "DE89370400440532013000" }, "bic": { "type": "string", "example": "COBADEFF" }, "country": { "type": "string", "example": "DEU" } } } } } } } } } } } }, { "title": "YELLOW (PD) — verification in progress", "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "answer": { "type": "string", "example": "YELLOW" }, "checkType": { "type": "string", "example": "BANK_DETAILS_CHECK" }, "createdAt": { "type": "string", "example": "2025-02-06 09:50:47" }, "id": { "type": "string", "example": "5e5eeaca-3ec0-450b-ad4f-5121813cd096" }, "inputDoc": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "PROOF_OF_PAYMENT" }, "country": { "type": "string", "example": "DNK" } } }, "ekycCheckInfo": { "type": "object", "properties": { "confirmationId": { "type": "string", "example": "Fip2DKtUbkSSuLBmOzpyfAHi" }, "confirmationType": { "type": "string", "example": "oAuth" } } } } } } } }, { "title": "ERROR (PD) — service unavailable", "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "answer": { "type": "string", "example": "ERROR" }, "checkType": { "type": "string", "example": "BANK_DETAILS_CHECK" }, "createdAt": { "type": "string", "example": "2025-02-05 12:46:04" }, "id": { "type": "string", "example": "6bf059dc-03d6-4c4c-96d6-d4fec6245def" }, "inputDoc": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "PROOF_OF_PAYMENT" }, "country": { "type": "string", "example": "DEU" } } }, "ekycCheckInfo": { "type": "object", "properties": {} } } } } } }, { "title": "GREEN (BAV) — applicant passed verification", "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "answer": { "type": "string", "example": "GREEN" }, "checkType": { "type": "string", "example": "BANK_DETAILS_CHECK" }, "createdAt": { "type": "string", "example": "2025-05-18 19:20:59" }, "id": { "type": "string", "example": "34fbc1c8-164d-4bcf-b085-7f0323b2e0cf" }, "inputDoc": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "OTHER" }, "country": { "type": "string", "example": "FIN" } } }, "extractedDoc": { "type": "object", "properties": { "country": { "type": "string", "example": "FIN" }, "firstName": { "type": "string", "example": "Mikko Virtanen" } } }, "ekycCheckInfo": { "type": "object", "properties": { "confirmationId": { "type": "string", "example": "st8KmCZMPXog2SnTR75vDLs3" }, "confirmationType": { "type": "string", "example": "oAuth" } } }, "bankDetailsCheckInfo": { "type": "object", "properties": { "accountDetails": { "type": "object", "properties": { "personFullName": { "type": "string", "example": "Mikko Virtanen" }, "legalAge": { "type": "boolean", "example": true, "default": true }, "iban": { "type": "string", "example": "FI3012345600000785" }, "accountType": { "type": "string", "example": "CACC" }, "creditLimit": { "type": "object", "properties": { "amount": { "type": "integer", "example": 10000, "default": 0 }, "currency": { "type": "string", "example": "EUR" } } }, "bankName": { "type": "string", "example": "S-Pankki" }, "bic": { "type": "string", "example": "SPANKFIHXXX" }, "country": { "type": "string", "example": "FIN" }, "balanceDetails": { "type": "object", "properties": { "moneyAmount": { "type": "object", "properties": { "amount": { "type": "integer", "example": 3000, "default": 0 }, "currency": { "type": "string", "example": "EUR" } } }, "balanceType": { "type": "string", "example": "CLAV" }, "lastTransactionDate": { "type": "string", "example": "2025-05-18 19:20:59" } } } } } } } } } } } }, { "title": "YELLOW (BAV) — verification in progress", "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "answer": { "type": "string", "example": "YELLOW" }, "checkType": { "type": "string", "example": "BANK_DETAILS_CHECK" }, "createdAt": { "type": "string", "example": "2025-06-18 09:20:35" }, "id": { "type": "string", "example": "e7b3b71f-5278-4e63-ba17-377377779b0b" }, "inputDoc": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "OTHER" }, "country": { "type": "string", "example": "FIN" } } }, "ekycCheckInfo": { "type": "object", "properties": { "confirmationId": { "type": "string", "example": "u8M2pnx58JHSCthoSC1o7yu1" }, "confirmationType": { "type": "string", "example": "options" } } } } } } } }, { "title": "RED (BAV) — applicant rejected", "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "answer": { "type": "string", "example": "RED" }, "checkType": { "type": "string", "example": "BANK_DETAILS_CHECK" }, "createdAt": { "type": "string", "example": "2025-05-18 19:20:59" }, "id": { "type": "string", "example": "34fbc1c8-164d-4bcf-b085-7f0323b2e0cf" }, "inputDoc": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "OTHER" }, "country": { "type": "string", "example": "FIN" } } }, "extractedDoc": { "type": "object", "properties": { "country": { "type": "string", "example": "FIN" }, "firstName": { "type": "string", "example": "Mikko Virtanen" } } }, "ekycCheckInfo": { "type": "object", "properties": { "confirmationId": { "type": "string", "example": "st8KmCZMPXog2SnTR75vDLs3" }, "confirmationType": { "type": "string", "example": "oAuth" } } }, "bankDetailsCheckInfo": { "type": "object", "properties": { "accountDetails": { "type": "object", "properties": { "personFullName": { "type": "string", "example": "Mikko Virtanen" }, "legalAge": { "type": "boolean", "example": false, "default": true }, "iban": { "type": "string", "example": "FI3012345600000785" }, "accountType": { "type": "string", "example": "CACC" }, "creditLimit": { "type": "object", "properties": { "amount": { "type": "integer", "example": 10000, "default": 0 }, "currency": { "type": "string", "example": "EUR" } } }, "bankName": { "type": "string", "example": "S-Pankki" }, "bic": { "type": "string", "example": "SPANKFIHXXX" }, "country": { "type": "string", "example": "FIN" }, "balanceDetails": { "type": "object", "properties": { "moneyAmount": { "type": "object", "properties": { "amount": { "type": "integer", "example": 3000, "default": 0 }, "currency": { "type": "string", "example": "EUR" } } }, "balanceType": { "type": "string", "example": "CLAV" }, "lastTransactionDate": { "type": "string", "example": "2025-05-18 19:20:59" } } } } } } }, "violations": { "type": "array", "items": { "type": "string", "example": "PERSON_IS_MINOR" } } } } } } }, { "title": "ERROR (BAV) — service unavailable", "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "answer": { "type": "string", "example": "ERROR" }, "checkType": { "type": "string", "example": "BANK_DETAILS_CHECK" }, "createdAt": { "type": "string", "example": "2025-02-05 12:46:04" }, "id": { "type": "string", "example": "6bf059dc-03d6-4c4c-96d6-d4fec6245def" }, "inputDoc": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "OTHER" }, "country": { "type": "string", "example": "FIN" } } }, "ekycCheckInfo": { "type": "object", "properties": {} } } } } } } ] } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Applicant ID not found": { "value": "{\n \"description\": \"Applicant with id 67346775989cba6a82b621de not found\",\n \"code\": 404,\n \"correlationId\": \"3b156dad5a2dfe4bec2485b2039f7e64\"\n}" } }, "schema": { "type": "object", "properties": { "description": { "type": "string", "example": "Applicant with id 67346775989cba6a82b621de not found" }, "code": { "type": "integer", "example": 404, "default": 0 }, "correlationId": { "type": "string", "example": "3b156dad5a2dfe4bec2485b2039f7e64" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```