Sign in

v3

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

Get verification

Get customer verification result.

get/verifications/{verification_id}

Path parameters

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

Verification's unique identifier.

Response

Verification representation.

business_idstring uuid

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

creation_timestring date-time

The date and time the resource was created.

customer_initiatedboolean

Indicates whether the verification was initiated by the customer.

idstring uuid

Unique ID for this verification result.

last_updated_timestring date-time

The date and time the resource was last updated.

metadataMetadata

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

person_idstring uuid

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

result'ACCEPTED' | 'PENDING' | 'PROVISIONAL' | 'REJECTED' | 'REVIEW' | 'UNVERIFIED' | 'VENDOR_ERROR' required

The determination of this verification. One of the following:

  • UNVERIFIED – record representing the absence of a verification.
  • 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.
  • VENDOR_ERROR – verification did not successfully run due to an unexpected error or failure.
  • REJECTED – the customer was rejected and should not be allowed to take certain actions e.g., open an account.
verification_timestring date-time required

The date and time the verification was completed.

verification_type'DOCUMENT_VERIFICATION' | 'IDENTITY' | 'LICENSE' | 'MANUAL_REVIEW' | 'RELATED_ENTITIES' | 'WATCHLIST' required

The verification run on the customer. One the following:

  • IDENTITY – verify that the information provided is associated with the identity of a real person or business.
  • WATCHLIST – checks watchlists for known fraud, money laundering, and other suspicious activity.
  • DOCUMENT_VERIFICATION – verifies the authenticity of a document, such as a driver's license, or other government-issued identification document.
  • RELATED_ENTITIES – represents dependent verification checks for related parties (e.g. all beneficial owners must pass KYC for a business to pass KYB).
  • MANUAL_REVIEW – represents the outcome of a manual review of the verification done on a party (note: overrides the outcome of other verification types).
  • LICENSE – represents the outcome of a license verification.

Example response

{
  "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"
}