Banking Verification Status

Deprecated

This endpoint is deprecated. Use GET /v3/customers/{customer_id}/kyc, which answers 204 instead of creating an empty record when there is none. It keeps working while integrations move; see Versioning.

This endpoint retrieves the current banking verification status and details for a specific account.

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

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

GET

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

Path Parameters

Parameter	Type	Description
accountId	string (uuid)	Required. The account ID to check verification status for.

Response Sample

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "status": "in_review",
  "verificationUrl": "https://verify.blockwyre.com/v2/verification/<token>",
  "statusReason": "Additional documents required",
  "phone": "+1234567890",
  "dateOfBirth": "1990-05-15",
  "nationality": "US",
  "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"
  },
  "eventHistory": [
    {
      "status": "in_review",
      "statusReason": "Verification submitted",
      "date": "2023-01-01T10:00:00Z"
    },
    {
      "status": "pending",
      "statusReason": "Account created",
      "date": "2023-01-01T00:00:00Z"
    }
  ],
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z"
}

Response Schema

Field	Type	Description
accountId	string (uuid)	The account ID.
status	string	Verification status. Possible values: pending, in_review, approved, needs_update, rejected.
verificationUrl	string	Verification link for document upload (optional).
statusReason	string	Additional information about the verification status (optional).
phone	string	Phone number in E.164 format.
dateOfBirth	string	Date of birth in ISO 8601 format (YYYY-MM-DD).
nationality	string	Nationality code (ISO 3166-1 alpha-2).
documentId	object	Document ID information.
documentId.idNumber	string	Document identification number.
documentId.idDocumentType	string	Document type. Possible values: passport, driver_license, national_id.
documentId.idIssueDate	string	Document issue date (YYYY-MM-DD).
documentId.idExpiryDate	string	Document expiry date (YYYY-MM-DD).
documentId.idCountryOfIssue	string	Country of issue (ISO 3166-1 alpha-2).
documentId.nationality	string	Nationality (ISO 3166-1 alpha-2).
address	object	Address information.
address.address1	string	Primary address line.
address.address2	string	Secondary address line (optional).
address.city	string	City name.
address.state	string	State or province.
address.postalCode	string	Postal or ZIP code.
address.country	string	Country code (ISO 3166-1 alpha-2).
eventHistory	array	History of status changes with timestamps.
eventHistory[].status	string	Status at this point in time.
eventHistory[].statusReason	string	Reason for the status change.
eventHistory[].date	string	Timestamp of the status change (ISO 8601).
createdAt	string	Timestamp when the record was created (ISO 8601).
updatedAt	string	Timestamp when the record was last updated (ISO 8601).

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!