Skip to main content
POST
Verify a customer's identity

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Whether this customer has consented to be verified.

business_id
string<uuid>

Business ID for the application. An application must have either a Business or a customer associated with it.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

customer_initiated
boolean

Whether this verification request was initiated by the customer.

customer_ip_address
string

The customer's IP address.

Example:

"140.151.183.216"

document_id
string

The ID of the uploaded government-issued identification document provided by the Socure SDK.

Example:

"1ab2c3de-fg45-6789-a01b-23c45678defg"

person_id
string<uuid>

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

Created identity request.

verification_status
enum<string>
required
read-only

The result of a KYC/KYB verification. One of the following:

  • UNVERIFIED โ€“ verification has not been completed for this customer.
  • PENDING โ€“ verification is in progress for this customer.
  • PROVISIONAL โ€“ partially verified or verified with restrictions.
  • ACCEPTED โ€“ the customer has been verified.
  • REVIEW โ€“ verification has run and issues have been identified and require review.
  • REJECTED โ€“ the customer was rejected and should not be allowed to take certain actions e.g., open an account.
Available options:
UNVERIFIED,
PENDING,
PROVISIONAL,
ACCEPTED,
REVIEW,
REJECTED
Example:

"ACCEPTED"

verifications
object[]
required

Array of verification results.

next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"