Sign in

v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-1770249709.0 KB
Customers

Review a customer's identity results

Retrieves and analyzes the results of a customer's identity validation and fraud score. This endpoint provides a comprehensive breakdown of the validation outcome, including:

  • Risk and correlation scores
  • Reason codes for the decision
  • Results of watchlist screening
  • Any network alerts detected Use this endpoint to gain insights into the verification process and make informed decisions about customer onboarding.
get/v1/customers/{id}/review

Path parameters

idstring uuid required

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Response

OK

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Example response

{
  "data": {
    "customer_details": {
      "name": "Ron Swanson",
      "email": "ron.swanson@pawnee.com",
      "phone": "+12128675309",
      "address": {
        "address1": "123 Main St",
        "address2": "Apt 1",
        "city": "Anytown",
        "state": "CA",
        "zip": "12345"
      },
      "compliance_profile": {
        "ssn": "***-**-****"
      },
      "device": {
        "ip_address": "192.168.1.1"
      }
    }
  }
}