v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

KYC/KYB Verifications

List verifications

List customer verification results.

get/verifications

Query parameters

include_historyboolean

If true, include old (inactive) records as well.

idstring[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

verification_typeVerificationType[]

The type of verification run. Multiple values can be provided as a comma-separated list.

[
  "IDENTITY"
]

business_idstring[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

resultVerificationResult[]

The result of the verification that was run on the party. Multiple values can be provided as a comma-separated list.

[
  "ACCEPTED"
]

person_idstring[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

Response

List verifications.

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

{
  "next_page_token": "a8937a0d",
  "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"
    }
  ]
}