Get KYC Record
An individual customer's verification record: the applicant's details, the status and its history. Reading never creates a record.
Takes a workspace-scoped API key or a dashboard session. An account-scoped key is refused with 401.
Replaces GET /api/v2/kyc/banking-verification/individual/{accountId}.
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
/v3/customers/{customer_id}/kyc
Path parameters
| Parameter | Type | Description |
|---|---|---|
customer_id | string (cst_…) | Required. The customer. |
Response Sample
{
"id": "kyc_01k8x494z0e2escqpt6bde8hag",
"customer_id": "cst_01k8x40x9gfx6sv8a99hswy9bd",
"type": "banking",
"status": "in_review",
"status_reason": "verification requested",
"provider": "braid",
"email": "samantha@example.com",
"first_name": "Samantha",
"last_name": "Reyes",
"phone": "+14155550123",
"date_of_birth": "1990-04-12",
"nationality": "US",
"address": {
"line1": "742 Evergreen Terrace",
"line2": "Apt 2",
"city": "Springfield",
"state": "OR",
"postal_code": "97477",
"country": "US"
},
"identity_document": {
"number": "X1234567",
"type": "passport",
"issue_date": "2018-03-01",
"expiry_date": "2028-03-01",
"country_of_issue": "US"
},
"occupation": "Engineer",
"employed_company_name": "Northwind Traders",
"employed_job_title": "Staff Engineer",
"source_of_funds": ["salary"],
"ready": true,
"event_history": [
{
"status": "in_review",
"status_reason": "verification requested",
"date": "2025-10-31T12:47:10Z"
},
{
"status": "pending",
"status_reason": "verification record created",
"date": "2025-10-31T12:36:04Z"
}
],
"created_at": "2025-10-31T12:36:04Z",
"updated_at": "2025-10-31T12:47:10Z"
}
Answers 204 No Content, with no body, when the customer has no record yet (open one with Open KYC Record). That is an empty state, not an error. An id that names no customer of the workspace answers 404 customer_not_found.
Response Schema
See Open KYC Record.
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | customer_id is not a cst_… TypeID. |
401 | unauthorized | Missing or invalid signature, or the caller is an account-scoped key or a customer session. |
403 | forbidden | A dashboard member whose role does not allow this. A workspace-scoped key always may. |
404 | customer_not_found | No such customer in this workspace. |
Coming from v2
v2 (GET …/individual/{accountId}) | v3 |
|---|---|
accountId (uuid) | customer_id (cst_…) |
| creates an empty record when there is none | 204, nothing created |
verificationUrl | not returned |
statusReason, dateOfBirth | status_reason, date_of_birth |
documentId (with nationality inside) | identity_document; nationality is top-level |
documentId.idNumber, idDocumentType, idIssueDate, idExpiryDate, idCountryOfIssue | identity_document.number, type, issue_date, expiry_date, country_of_issue |
address.address1, address2, postalCode | address.line1, line2, postal_code |
eventHistory[].statusReason | event_history[].status_reason |
createdAt, updatedAt | created_at, updated_at |
| none | id, type, provider, ready, names, email, employment, source_of_funds |
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!