Skip to main content

Request Banking Verification

Deprecated

This endpoint is deprecated. Use POST /v3/customers/{customer_id}/kyc/request-verification, which checks the applicant's details and documents before handing the record to the provider. It keeps working while integrations move; see Versioning.

This endpoint submits the individual banking verification to the provider and generates a verification link.

Takes a workspace-scoped API key. An account-scoped key is refused with 403.

Prerequisites​

  • The individual banking verification data must be submitted first using the Submit Banking Verification endpoint.
  • If the account is already approved or in_review, the existing verification is returned.

Technical Details​

  • Status Change: Submitting verification changes the account status from pending to in_review.
  • A verification URL is generated for the user to complete the verification process.
Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
  Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

POST

/api/v2/kyc/banking-verification/individual/{accountId}/request-verification

Path Parameters​

ParameterTypeDescription
accountIdstring (uuid)Required. The account ID to request verification for.

Response Sample​

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "verificationUrl": "https://verify.blockwyre.com/v2/verification/<token>"
}

Response Schema​

FieldTypeDescription
accountIdstring (uuid)The account ID.
verificationUrlstringThe verification URL for the user to complete the verification process.

Error Responses​

Verification Data Not Submitted​

If the banking verification data has not been submitted first, you will receive a 400 Bad Request error.

Make sure to submit the banking verification data using the Submit Banking Verification endpoint before calling this endpoint.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!