Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
KYC Verification (deprecated)

Verify a customer's identity

Initiate identity verification for a customer and run the specified identity checks.

Verifying a personal customer requires that the following fields already be set:

  • first_name
  • last_name
  • dob
  • email
  • phone_number
  • legal_address
  • ssn

This endpoint will be removed in API v1. Use POST /v0/verifications/verify instead.

post/customers/{customer_id}/verify

Path parameters

customer_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The customer's unique identifier

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

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.

Request body

customer_consentboolean required

Whether this customer has consented to a KYC check.

customer_ip_addressstring

IP address of the customer being verified.

document_idstring

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

verification_typeKycVerificationType[]

List of possible checks to run on a customer. This is a legacy field that is now ignored.

Example request

{
  "customer_consent": true,
  "customer_ip_address": "66.152.213.183"
}

Response

Customer verification result.

kyc_status'ACCEPTED' | 'PENDING' | 'PROVIDER_FAILURE' | 'PROVISIONAL' | 'REJECTED' | 'REVIEW' | 'UNVERIFIED' required

Customer's KYC status

next_page_tokenstring

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

Example response

{
  "verifications": [
    {
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "issues": [
        "R186: Global Watchlist sources selected are correlated with the input identifiers"
      ],
      "raw_response": {
        "provider": "SOCURE",
        "raw_data": "{}"
      },
      "result": "ACCEPTED",
      "vendor_info": {
        "details": [
          {
            "code": "R186",
            "description": "Global Watchlist sources selected are correlated with the input identifiers"
          }
        ],
        "vendor": "IDOLOGY"
      },
      "verification_type": "kyc"
    }
  ],
  "next_page_token": "a8937a0d"
}