Everything You Need to Know About Verifying Bank Accounts with Our API

General Questions

Q1: What is the purpose of the Bank Account Check API?

• This API is used to verify whether a bank account exists and retrieve the associated account name if it exists.

Q2: What do I need to start using the Bank Account Check API?

• You need an access token. You can generate it using the Token Authentication API.

Q3: Can this API be used in China?

• Yes, but you must use a VPN to avoid packet loss, service timeout, and other issues since the service is deployed overseas.

Integration and Usage

Q4: What is the request URL and method for the Bank Account Check API?

• URL: https://api.advance.ai/openapi/verification/v1/bank-account-check

• Method: POST (Content-Type: application/json)

Q5: What are the required headers and parameters for the request?

• Headers:

  • X-ACCESS-TOKEN: Your access token.

  • Content-Type: application/json

• Body Parameters:

  • bankCode (string): Alphanumeric (3-100 characters).

  • bankAccount (string): 3-20 digits.

Q6: How do I find valid bankCode values?

• Refer to the documentation for a complete list of valid bankCode values.

Responses

Q7: What does a successful response look like?

• When the account exists:

  {
      "code": "SUCCESS",
      "message": "OK",
      "data": {
          "accountExists": true,
          "accountName": "John Doe"
      },
      "transactionId": "123456789",
      "pricingStrategy": "PAY"
  }

• When the account does not exist:

  {
      "code": "SUCCESS",
      "message": "OK",
      "data": {
          "accountExists": false,
          "accountName": null
      },
      "transactionId": "987654321",
      "pricingStrategy": "PAY"
  }

Q8: What happens if there is an error in the parameters?

• Example response:

  {
      "code": "PARAMETER_ERROR",
      "message": "Invalid bank code, please check the bank code format",
      "data": null,
      "transactionId": "123456789",
      "pricingStrategy": "FREE"
  }

Q9: What does the pricingStrategy field indicate?

• FREE: No charge for the request.

• PAY: The request incurs a charge.

Q10: How do I handle a RETRY_LATER response?

• The response indicates a temporary issue. Retry the request after the suggested time provided in the HTTP headers.