Skip to main content

Verification Flow

An individual customer is verified through one KYC record, under /v3/customers/{customer_id}/kyc. Business customers are verified through KYB instead; these endpoints answer 422 kyc_business_not_supported for them.

Every endpoint here takes a workspace-scoped API key or a dashboard session. An account-scoped key is refused with 401.

The steps, in order​

  1. Open the record: POST /v3/customers/{customer_id}/kyc. Safe to repeat.
  2. Write the applicant's details: PATCH /v3/customers/{customer_id}/kyc, as often as needed while the record is pending.
  3. Upload the identity documents, one slot at a time (face, document-front, and document-back when the document has one):
    1. Presign the upload,
    2. post the file straight to the URL it returns,
    3. complete the upload.
  4. Request verification: POST /v3/customers/{customer_id}/kyc/request-verification. If you already verified the applicant with your own provider, use Submit External Verification instead.

Then read the outcome with GET /v3/customers/{customer_id}/kyc.

Statuses​

statusMeansDetails and documents editable
pendingOpen; verification not requested yet.yes
in_reviewHanded to the verification provider.no
approvedVerified.no
needs_updateSent back for changes.yes
rejectedRefused. It cannot be resubmitted.no

The customer's verification_status on Get Customer follows this record.

Coming from v2​

  • v2 saved the details and answered a verificationUrl for the applicant to upload documents. v3 has no verification link: you upload the documents through the API.
  • v2's GET created an empty record when there was none. v3's answers 204, and you open the record with POST.
  • v2 approved an external verification on the spot. v3 hands it to the provider like any other, and the record goes in_review until it decides.

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:

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!