Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
KYC/KYB Verifications

Verify a customer's identity

Initiate identity verification 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

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

  • entity_name
  • legal_address
post/verifications/verify

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

business_idstring uuid

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

customer_consentboolean required

Whether this customer has consented to be verified.

customer_initiatedboolean

Whether this verification request was initiated by the customer.

customer_ip_addressstring

The customer's IP address.

document_idstring

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

person_idstring uuid

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

Example request

{
  "customer_consent": true,
  "customer_ip_address": "235.2.7.2",
  "person_id": "1bb26bcb-0e1b-4060-972d-80891332aae2"
}

Response

Created identity request.

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.

verification_status'ACCEPTED' | 'PENDING' | 'PROVISIONAL' | 'REJECTED' | 'REVIEW' | 'UNVERIFIED' required

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.

Example response

{
  "next_page_token": "a8937a0d",
  "verification_status": "ACCEPTED",
  "verifications": [
    {
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "details": [
        {
          "description": "Email address is correlated with the individual's name",
          "label": "Email",
          "result": "PASS",
          "score": 0.25,
          "url": "http://example.com/additional-information",
          "vendor_code": "R940"
        }
      ],
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "result": "ACCEPTED",
      "vendor_info": {
        "vendor": "SOCURE"
      },
      "verification_type": "IDENTITY"
    }
  ]
}