Card Verification Status

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

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
  Authorization: APIKey {YOUR_API_KEY}

Endpoint

GET

/api/v2/kyc/card-verification/{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",
  "statusReason": "Additional documents required",
  "email": "jwick@localhost",
  "firstName": "John",
  "lastName": "Wick",
  "dateOfBirth": "1990-05-15",
  "phone": "+1234567890",
  "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.
statusReason	string	Additional information about the verification status (optional).
email	string	Account email address.
firstName	string	Account holder's first name.
lastName	string	Account holder's last name.
dateOfBirth	string	Date of birth in ISO 8601 format (YYYY-MM-DD).
phone	string	Phone number in E.164 format.
nationality	string	Nationality code (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).

Verification Status

The status field indicates the current state of the account verification:

Status	Description
pending	Account is awaiting verification information submission. No verification data has been submitted yet.
in_review	Verification information has been submitted and is currently being reviewed by the compliance team.
approved	Verification has been approved. Account can use credit card services.
needs_update	Additional information or corrections are required. Account must resubmit verification data.
rejected	Verification has been rejected. Account cannot use credit card services.

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!