GET
/
v1
/
customers
/
{id}
/
review
import Straddle from '@straddleio/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const customerReviewV1 = await client.customers.review.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

  console.log(customerReviewV1.data);
}

main();
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "customer_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Ron Swanson",
      "type": "individual",
      "email": "ron.swanson@pawnee.com",
      "phone": "+12128675309",
      "external_id": "<string>",
      "status": "verified",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "address": {
        "address1": "123 Main St",
        "address2": "Apt 1",
        "city": "Anytown",
        "state": "CA",
        "zip": "12345"
      },
      "compliance_profile": {
        "dob": "****-**-**",
        "ssn": "***-**-****"
      },
      "device": {
        "ip_address": "192.168.1.1"
      },
      "metadata": {}
    },
    "identity_details": {
      "review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "decision": "accept",
      "messages": {},
      "breakdown": {
        "address": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        },
        "email": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        },
        "fraud": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        },
        "phone": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        },
        "synthetic": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        },
        "business_identification": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        },
        "business_validation": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        },
        "business_evaluation": {
          "decision": "accept",
          "codes": [
            "<string>"
          ],
          "risk_score": 123,
          "correlation_score": 123
        }
      },
      "network_alerts": {
        "decision": "accept",
        "codes": [
          "<string>"
        ],
        "alerts": [
          "<string>"
        ]
      },
      "watch_list": {
        "decision": "accept",
        "codes": [
          "<string>"
        ],
        "matched": [
          "<string>"
        ],
        "matches": [
          {
            "list_name": "<string>",
            "urls": [
              "<string>"
            ],
            "match_fields": [
              "<string>"
            ],
            "correlation": "low_confidence"
          }
        ]
      },
      "kyc": {
        "decision": "accept",
        "codes": [
          "<string>"
        ],
        "validations": {
          "first_name": true,
          "last_name": true,
          "address": true,
          "city": true,
          "state": true,
          "zip": true,
          "phone": true,
          "dob": true,
          "ssn": true,
          "email": true
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

Headers

​
Straddle-Account-Id
string

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

​
Request-Id
string

Optional client generated identifier to trace and debug a request.

​
Correlation-Id
string

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

Path Parameters

​
id
string
required

Response

200
text/plain
OK
​
meta
object
required

Metadata about the API request, including an identifier and timestamp.

​
response_type
enum<string>
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.
Available options:
object,
array,
error,
none
​
data
object
required
Suggest editsRaise issue