Fundamentals
Customers
Charges
Payouts
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Review a customer
Use this endpoint to review the identity and risk scores of an existing customer.
Authorizations
Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.
Headers
For use by platforms to specify an account id and set scope of a request.
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Path Parameters
Response
Timestamp of when the customer record was created.
The customer's email address.
Unique identifier for the customer.
Full name of the individual or business name.
The customer's phone number in E.164 format.
pending
, review
, verified
, inactive
, rejected
individual
, business
Timestamp of the most recent update to the customer record.
Primary address line (e.g., street, PO Box).
100
City, district, suburb, town, or village.
100
Two-letter state code.
Zip or postal code.
Secondary address line (e.g., apartment, suite, unit, or building).
100
The customer's IP address at the time of profile creation. Use 0.0.0.0
to represent an offline customer registration.
1
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.
List of specific result codes from the fraud and risk screening.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept
, reject
, review
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
List of specific result codes from the fraud and risk screening.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept
, reject
, review
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
List of specific result codes from the fraud and risk screening.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept
, reject
, review
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
List of specific result codes from the fraud and risk screening.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept
, reject
, review
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
List of specific result codes from the fraud and risk screening.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept
, reject
, review
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Timestamp of when the review was initiated.
accept
, reject
, review
Unique identifier for the review.
Timestamp of the most recent update to the review.
Boolean values indicating the result of each validation in the KYC process.
List of specific result codes from the KYC screening process.
accept
, reject
, review
Dictionary of all messages from the customer verification process.
Any alerts or flags raised during the consortium alert screening.
List of specific result codes from the consortium alert screening.
accept
, reject
, review
Specific codes related to the Straddle watchlist screening results.
accept
, reject
, review
Information about any matches found during screening.
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.
object
, array
, error
, none