Verification Flow
An individual customer is verified through one KYC record, under /v3/customers//kyc. Business customers are verified through KYB instead; these endpoints answer 422 kycbusinessnotsupported for them.
Open KYC Record
Opens an individual customer's verification record, empty and pending. A customer has one: opening it again returns the existing record with 200 instead of a conflict, so a retry is safe and needs no Idempotency-Key.
Get KYC Record
An individual customer's verification record: the applicant's details, the status and its history. Reading never creates a record.
Submit KYC Details
Writes the applicant's details onto the customer's verification record. It does not change the status and does not start verification: request it when the details and documents are in.
Presign a Document Upload
Authorizes the upload of one identity document and returns a form to post the file to. The file goes straight to storage, never through this API.
Complete a Document Upload
Confirms that a presigned upload arrived. It reads the file's real size from storage and marks the document ready. Only ready documents count for Request Verification, so call this after every upload.
List Documents
The identity documents on a customer's verification record, whether each upload was confirmed, and the size limits that apply, so you can check a file before presigning it.
Delete a Document
Removes an identity document from a customer's verification record. The slot is freed and its bytes return to the record's budget. To replace a document, you can also presign its slot again.
Request Verification
Hands a customer's verification record to the verification provider. The record moves to inreview, and the provider's verdict, approved or rejected, lands on it later that status comes only from a BlockWyre staff review, which can also settle the record.
Submit External Verification
For an applicant you already verified with your own identity provider (Sumsub, Jumio, Onfido, your own stack). It records which provider it was and its raw result on the customer's verification record, then hands the record to the verification provider exactly as Request Verification does.