Submit Banking Verification

Deprecated

This endpoint is deprecated. Use POST /v3/customers/{customer_id}/kyc to open the record and PATCH /v3/customers/{customer_id}/kyc to write the applicant's details; documents are uploaded through the API instead of a verification link. It keeps working while integrations move; see Versioning.

This endpoint initiates the banking verification process for ACH services by accepting KYC information and generating a verification link for document upload.

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

Technical Details

• This endpoint saves personal data for banking verification. It does not submit to the verification provider or change the account status.
• The account must be in pending or needs_update status to submit verification data.
• Use the Request Banking Verification endpoint to submit the verification to the provider and trigger the status change to in_review.
• Returns a verification link where the user can upload required documents.

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

Request Body Sample

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "dateOfBirth": "1990-05-15",
  "phone": "+1234567890",
  "documentId": {
    "idNumber": "AB1234567",
    "idDocumentType": "passport",
    "idIssueDate": "2020-01-15",
    "idExpiryDate": "2030-01-15",
    "idCountryOfIssue": "US",
    "nationality": "US"
  },
  "address": {
    "address1": "123 Main St",
    "address2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  }
}

Request Body Schema

Field	Type	Description
accountId	string (uuid)	Required. The account ID to verify.
dateOfBirth	string	Required. Date of birth in ISO 8601 format (YYYY-MM-DD). Example: 1990-05-15.
phone	string	Required. Phone number in E.164 format. Example: +1234567890.
documentId	object	Required. Identity document information.
documentId.idNumber	string	Required. Document ID number. 2-20 characters.
documentId.idDocumentType	string	Required. Document type. See values below.
documentId.idIssueDate	string	Optional. Document issue date (YYYY-MM-DD).
documentId.idExpiryDate	string	Optional. Document expiry date (YYYY-MM-DD).
documentId.idCountryOfIssue	string	Optional. Country that issued the document (ISO 3166-1 alpha-2).
documentId.nationality	string	Optional. Nationality (ISO 3166-1 alpha-2).
address	object	Required. Address information.
address.address1	string	Required. Primary address line. Max 255 characters.
address.address2	string	Optional. Secondary address line. Max 255 characters.
address.city	string	Required. City name. Max 100 characters.
address.state	string	Required. State code. Max 100 characters.
address.postalCode	string	Required. Postal or ZIP code.
address.country	string	Required. Country code in ISO 3166-1 alpha-2 format. Example: US.

Document Types

Value	Description
passport	Passport
driver_license	Driver's License
national_id	National ID Card
ssn	Social Security Number
itin	Individual Taxpayer Identification Number
ein	Employer Identification Number
other	Other document type

Response Sample

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

Response Schema

Field	Type	Description
accountId	string (uuid)	The account ID.
verificationUrl	string (url)	Unique verification link where the user can upload required documents and complete the verification process. Open it as returned; do not build it. In production it has the form https://verify.blockwyre.com/v2/verification/<token>. In sandbox it is on https://api-sandbox.blockwyre.xyz and leads to the verification simulator, where you choose the outcome (approved, declined or resubmission_requested).

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:

• Instagram: BlockWyre Instagram
• Twitter: BlockWyre Twitter
• Facebook: BlockWyre Facebook
• LinkedIn: BlockWyre LinkedIn

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!