Request Card Verification from Banking
This endpoint creates a card verification by cloning data from an approved banking KYC verification. This allows accounts that have already completed banking verification to automatically obtain card verification without going through the verification process again.
Prerequisites
- The account must have a banking verification with
approvedstatus. - If the account already has an approved card verification, the existing verification is returned.
Technical Details
- Status Change: The card verification is immediately set to
approvedstatus since it inherits the approved banking verification. - All personal information (name, address, date of birth, etc.) is copied from the banking KYC record.
- This is a streamlined process for users who have already been verified for banking services.
Authorization:
bearer
HTTP: bearer
HTTP Authorization Scheme: bearer
Headers:
Authorization: APIKey {YOUR_API_KEY}
Endpoint
/api/v2/kyc/card-verification/{accountId}/request-verification
Path Parameters
| Parameter | Type | Description |
|---|---|---|
accountId | string (uuid) | Required. The account ID to request card verification for. |
Response Sample
{
"accountId": "00000000-0000-0000-0000-000000000000",
"status": "approved",
"statusReason": "Cloned from approved banking KYC",
"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": "approved",
"statusReason": "Cloned from approved banking KYC",
"date": "2023-01-01T10:00:00Z"
}
],
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T10:00:00Z"
}
Response Schema
| Field | Type | Description |
|---|---|---|
accountId | string (uuid) | The account ID. |
status | string | Verification status. Will be approved on successful request. |
statusReason | string | Reason for the status. |
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). |
Error Responses
Banking Verification Not Approved
If the banking verification is not approved, you will receive a 400 Bad Request error:
{
"error": "Banking verification must be approved. Current status: pending"
}
Make sure the account has completed the banking verification process and has been approved 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:
- 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!