Skip to main content

Submit Banking Verification

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

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:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
Authorization: APIKey {YOUR_API_KEY}

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

FieldTypeDescription
accountIdstring (uuid)Required. The account ID to verify.
dateOfBirthstringRequired. Date of birth in ISO 8601 format (YYYY-MM-DD). Example: 1990-05-15.
phonestringRequired. Phone number in E.164 format. Example: +1234567890.
documentIdobjectRequired. Identity document information.
documentId.idNumberstringRequired. Document ID number. 2-20 characters.
documentId.idDocumentTypestringRequired. Document type. See values below.
documentId.idIssueDatestringOptional. Document issue date (YYYY-MM-DD).
documentId.idExpiryDatestringOptional. Document expiry date (YYYY-MM-DD).
documentId.idCountryOfIssuestringOptional. Country that issued the document (ISO 3166-1 alpha-2).
documentId.nationalitystringOptional. Nationality (ISO 3166-1 alpha-2).
addressobjectRequired. Address information.
address.address1stringRequired. Primary address line. Max 255 characters.
address.address2stringOptional. Secondary address line. Max 255 characters.
address.citystringRequired. City name. Max 100 characters.
address.statestringRequired. State code. Max 100 characters.
address.postalCodestringRequired. Postal or ZIP code.
address.countrystringRequired. Country code in ISO 3166-1 alpha-2 format. Example: US.

Document Types

ValueDescription
passportPassport
driver_licenseDriver's License
national_idNational ID Card
ssnSocial Security Number
itinIndividual Taxpayer Identification Number
einEmployer Identification Number
otherOther document type

Response Sample

{
"accountId": "00000000-0000-0000-0000-000000000000",
"verificationUrl": "https://verify.blockwyre.com/v/abc123def456"
}

Response Schema

FieldTypeDescription
accountIdstring (uuid)The account ID.
verificationUrlstring (url)Unique verification link where the user can upload required documents and complete the verification process.

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!