Customers

Customers represent the end users who send or receive payments through your integration. Each customer undergoes automatic identity verification and fraud screening upon creation. Use customers to track payment history, manage bank account connections, and maintain a secure record of all transactions associated with a user. Customers can be either individuals or businesses with appropriate compliance checks for each type.

Lookup a customer

client.customers.get(, ?, ?): CustomerV1 { data, meta, response_type }

GET/v1/customers/{id}

Update a customer

client.customers.update(, , ?): CustomerV1 { data, meta, response_type }

PUT/v1/customers/{id}

Delete a customer

client.customers.delete(, ?, ?): CustomerV1 { data, meta, response_type }

DELETE/v1/customers/{id}

List customers

client.customers.list(?, ?): PageNumberSchema<Data { id, created_at, email, 6 more } >

GET/v1/customers

Create a customer

client.customers.create(, ?): CustomerV1 { data, meta, response_type }

POST/v1/customers

Unmask customer data

client.customers.unmasked(, ?, ?): CustomerUnmaskedV1 { data, meta, response_type }

GET/v1/customers/{id}/unmasked

ModelsExpand Collapse

CustomerAddressV1 { address1, city, state, 2 more }

An object containing the customer's address. This is optional, but if provided, all required fields must be present.

address1: string

Primary address line (e.g., street, PO Box).

maxLength100

city: string

City, district, suburb, town, or village.

maxLength100

state: string

Two-letter state code.

zip: string

Zip or postal code.

address2?: string | null

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

CustomerSummaryPagedV1 { data, meta, response_type }

data: Array<Data { id, created_at, email, 6 more } >

id: string

Unique identifier for the customer.

formatuuid

created_at: string

Timestamp of when the customer record was created.

formatdate-time

email: string

The customer's email address.

formatemail

Full name of the individual or business name.

phone: string

The customer's phone number in E.164 format.

status: "pending" | "review" | "verified" | 2 more

One of the following:

"pending"

"review"

"verified"

"inactive"

"rejected"

type: "individual" | "business"

One of the following:

"individual"

"business"

updated_at: string

Timestamp of the most recent update to the customer record.

formatdate-time

external_id?: string | null

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

meta: Meta { api_request_id, api_request_timestamp, max_page_size, 6 more }

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

max_page_size: number

Maximum allowed page size for this endpoint.

formatint32

page_number: number

Page number for paginated results.

formatint32

page_size: number

Number of items per page in this response.

formatint32

sort_by: string

The field that the results were sorted by.

sort_order: "asc" | "desc"

One of the following:

"asc"

"desc"

total_items: number

total_pages: number

The number of pages available.

formatint32

response_type: "object" | "array" | "error" | "none"

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.

One of the following:

"object"

"array"

"error"

"none"

CustomerUnmaskedV1 { data, meta, response_type }

data: Data { id, created_at, email, 11 more }

id: string

Unique identifier for the customer.

formatuuid

created_at: string

Timestamp of when the customer record was created.

formatdate-time

email: string

The customer's email address.

formatemail

Full name of the individual or business name.

phone: string

The customer's phone number in E.164 format.

status: "pending" | "review" | "verified" | 2 more

One of the following:

"pending"

"review"

"verified"

"inactive"

"rejected"

type: "individual" | "business"

One of the following:

"individual"

"business"

updated_at: string

Timestamp of the most recent update to the customer record.

formatdate-time

address?: CustomerAddressV1 { address1, city, state, 2 more } | null

An object containing the customer's address. This is optional, but if provided, all required fields must be present.

address1: string

Primary address line (e.g., street, PO Box).

maxLength100

city: string

City, district, suburb, town, or village.

maxLength100

state: string

Two-letter state code.

zip: string

Zip or postal code.

address2?: string | null

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

compliance_profile?: IndividualComplianceProfile { dob, ssn } | BusinessComplianceProfile { ein, legal_business_name, representatives, website } | null

Individual PII data required to trigger Patriot Act compliant KYC verification.

One of the following:

IndividualComplianceProfile { dob, ssn }

Individual PII data required to trigger Patriot Act compliant KYC verification.

dob: string | null

Date of birth (YYYY-MM-DD). Required for Patriot Act-compliant KYC verification.

formatdate

ssn: string | null

Social Security Number (format XXX-XX-XXXX). Required for Patriot Act-compliant KYC verification.

BusinessComplianceProfile { ein, legal_business_name, representatives, website }

Business registration data required to trigger Patriot Act compliant KYB verification.

ein: string | null

Employer Identification Number (format XX-XXXXXXX). Required for Patriot Act-compliant KYB verification.

legal_business_name: string | null

Official registered business name as listed with the IRS. This value will be matched against the 'legal_business name'.

representatives?: Array<Representative> | null

A list of people related to the company. Only valid where customer type is 'business'.

email?: string | null

phone?: string | null

website?: string | null

Official business website URL. Optional but recommended for enhanced KYB.

formaturi

config?: Config { processing_method, sandbox_outcome }

processing_method?: "inline" | "background" | "skip"

One of the following:

"inline"

"background"

"skip"

sandbox_outcome?: "standard" | "verified" | "rejected" | "review"

One of the following:

"standard"

"verified"

"rejected"

"review"

device?: DeviceUnmaskedV1 { ip_address }

ip_address: string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

external_id?: string | null

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

metadata?: Record<string, string> | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: "object" | "array" | "error" | "none"

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.

One of the following:

"object"

"array"

"error"

"none"

CustomerV1 { data, meta, response_type }

data: Data { id, created_at, email, 11 more }

id: string

Unique identifier for the customer.

formatuuid

created_at: string

Timestamp of when the customer record was created.

formatdate-time

email: string

The customer's email address.

formatemail

Full name of the individual or business name.

phone: string

The customer's phone number in E.164 format.

status: "pending" | "review" | "verified" | 2 more

One of the following:

"pending"

"review"

"verified"

"inactive"

"rejected"

type: "individual" | "business"

One of the following:

"individual"

"business"

updated_at: string

Timestamp of the most recent update to the customer record.

formatdate-time

address?: CustomerAddressV1 { address1, city, state, 2 more } | null

An object containing the customer's address. This is optional, but if provided, all required fields must be present.

address1: string

Primary address line (e.g., street, PO Box).

maxLength100

city: string

City, district, suburb, town, or village.

maxLength100

state: string

Two-letter state code.

zip: string

Zip or postal code.

address2?: string | null

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

compliance_profile?: IndividualComplianceProfile { dob, ssn } | BusinessComplianceProfile { ein, legal_business_name, representatives, website } | null

PII required to trigger Patriot Act compliant KYC verification.

One of the following:

IndividualComplianceProfile { dob, ssn }

PII required to trigger Patriot Act compliant KYC verification.

dob: string | null

Masked date of birth in ****-- format.

formatdate

ssn: string | null

Masked Social Security Number in the format --***.

BusinessComplianceProfile { ein, legal_business_name, representatives, website }

Business registration data required to trigger Patriot Act compliant KYB verification.

ein: string | null

Masked Employer Identification Number in the format -*****

legal_business_name: string | null

The official registered name of the business. This name should be correlated with the ein value.

representatives?: Array<Representative> | null

A list of people related to the company. Only valid where customer type is 'business'.

email?: string | null

phone?: string | null

website?: string | null

Official business website URL. Optional but recommended for enhanced KYB.

formaturi

config?: Config { processing_method, sandbox_outcome }

processing_method?: "inline" | "background" | "skip"

One of the following:

"inline"

"background"

"skip"

sandbox_outcome?: "standard" | "verified" | "rejected" | "review"

One of the following:

"standard"

"verified"

"rejected"

"review"

device?: Device { ip_address }

ip_address: string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

external_id?: string | null

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

metadata?: Record<string, string> | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: "object" | "array" | "error" | "none"

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.

One of the following:

"object"

"array"

"error"

"none"

DeviceUnmaskedV1 { ip_address }

ip_address: string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

CustomersReview

Review a customer's identity results

client.customers.review.get(, ?, ?): CustomerReviewV1 { data, meta, response_type }

GET/v1/customers/{id}/review

Update a customer's verification status

client.customers.review.decision(, , ?): CustomerV1 { data, meta, response_type }

PATCH/v1/customers/{id}/review

Update a customer's identity decision

client.customers.review.refreshReview(, ?, ?): CustomerV1 { data, meta, response_type }

PUT/v1/customers/{id}/refresh_review

ModelsExpand Collapse

CustomerReviewV1 { data, meta, response_type }

data: Data { customer_details, identity_details }

customer_details: CustomerDetails { id, created_at, email, 11 more }

id: string

Unique identifier for the customer.

formatuuid

created_at: string

Timestamp of when the customer record was created.

formatdate-time

email: string

The customer's email address.

formatemail

Full name of the individual or business name.

phone: string

The customer's phone number in E.164 format.

status: "pending" | "review" | "verified" | 2 more

One of the following:

"pending"

"review"

"verified"

"inactive"

"rejected"

type: "individual" | "business"

One of the following:

"individual"

"business"

updated_at: string

Timestamp of the most recent update to the customer record.

formatdate-time

address?: CustomerAddressV1 { address1, city, state, 2 more } | null

An object containing the customer's address. This is optional, but if provided, all required fields must be present.

address1: string

Primary address line (e.g., street, PO Box).

maxLength100

city: string

City, district, suburb, town, or village.

maxLength100

state: string

Two-letter state code.

zip: string

Zip or postal code.

address2?: string | null

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

compliance_profile?: IndividualComplianceProfile { dob, ssn } | BusinessComplianceProfile { ein, legal_business_name, representatives, website } | null

PII required to trigger Patriot Act compliant KYC verification.

One of the following:

IndividualComplianceProfile { dob, ssn }

PII required to trigger Patriot Act compliant KYC verification.

dob: string | null

Masked date of birth in ****-- format.

formatdate

ssn: string | null

Masked Social Security Number in the format --***.

BusinessComplianceProfile { ein, legal_business_name, representatives, website }

Business registration data required to trigger Patriot Act compliant KYB verification.

ein: string | null

Masked Employer Identification Number in the format -*****

legal_business_name: string | null

The official registered name of the business. This name should be correlated with the ein value.

representatives?: Array<Representative> | null

A list of people related to the company. Only valid where customer type is 'business'.

email?: string | null

phone?: string | null

website?: string | null

Official business website URL. Optional but recommended for enhanced KYB.

formaturi

config?: Config { processing_method, sandbox_outcome }

processing_method?: "inline" | "background" | "skip"

One of the following:

"inline"

"background"

"skip"

sandbox_outcome?: "standard" | "verified" | "rejected" | "review"

One of the following:

"standard"

"verified"

"rejected"

"review"

device?: Device { ip_address }

ip_address: string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

external_id?: string | null

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

metadata?: Record<string, string> | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

identity_details?: IdentityDetails { breakdown, created_at, decision, 7 more }

breakdown: Breakdown { address, business_evaluation, business_identification, 5 more }

Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.

address?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

business_evaluation?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

business_identification?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

business_validation?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

email?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

fraud?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

phone?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

synthetic?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

created_at: string

Timestamp of when the review was initiated.

formatdate-time

decision: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

review_id: string

Unique identifier for the review.

formatuuid

updated_at: string

Timestamp of the most recent update to the review.

formatdate-time

kyc?: KYC { validations, codes, decision }

validations: Validations { address, city, dob, 7 more }

Boolean values indicating the result of each validation in the KYC process.

address?: boolean

city?: boolean

dob?: boolean

email?: boolean

first_name?: boolean

last_name?: boolean

phone?: boolean

ssn?: boolean

state?: boolean

zip?: boolean

codes?: Array<string> | null

List of specific result codes from the KYC screening process.

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

messages?: Record<string, string> | null

Dictionary of all messages from the customer verification process.

network_alerts?: NetworkAlerts { alerts, codes, decision }

alerts?: Array<string> | null

Any alerts or flags raised during the consortium alert screening.

codes?: Array<string> | null

List of specific result codes from the consortium alert screening.

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

reputation?: Reputation { codes, decision, insights, risk_score }

codes?: Array<string> | null

Specific codes related to the Straddle reputation screening results.

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

insights?: Insights { accounts_active_count, accounts_closed_count, accounts_closed_dates, 30 more }

accounts_active_count?: number | null

accounts_closed_count?: number | null

accounts_closed_dates?: Array<string> | null

accounts_count?: number | null

accounts_fraud_count?: number | null

accounts_fraud_labeled_dates?: Array<string> | null

accounts_fraud_loss_total_amount?: number | null

ach_fraud_transactions_count?: number | null

ach_fraud_transactions_dates?: Array<string> | null

ach_fraud_transactions_total_amount?: number | null

ach_returned_transactions_count?: number | null

ach_returned_transactions_dates?: Array<string> | null

ach_returned_transactions_total_amount?: number | null

applications_approved_count?: number | null

applications_count?: number | null

applications_dates?: Array<string> | null

applications_declined_count?: number | null

applications_fraud_count?: number | null

card_disputed_transactions_count?: number | null

card_disputed_transactions_dates?: Array<string> | null

card_disputed_transactions_total_amount?: number | null

card_fraud_transactions_count?: number | null

card_fraud_transactions_dates?: Array<string> | null

card_fraud_transactions_total_amount?: number | null

card_stopped_transactions_count?: number | null

card_stopped_transactions_dates?: Array<string> | null

user_active_profile_count?: number | null

user_address_count?: number | null

user_closed_profile_count?: number | null

user_dob_count?: number | null

user_email_count?: number | null

user_institution_count?: number | null

user_mobile_count?: number | null

risk_score?: number | null

watch_list?: WatchList { codes, decision, matched, matches }

codes?: Array<string> | null

Specific codes related to the Straddle watchlist screening results.

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

matched?: Array<string> | null

Information about any matches found during screening.

matches?: Array<Match> | null

Information about any matches found during screening.

correlation: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

list_name: string

The name of the list the match was found.

match_fields: Array<string>

Data fields that matched.

urls: Array<string>

Relevent Urls to review.

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: "object" | "array" | "error" | "none"

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.

One of the following:

"object"

"array"

"error"

"none"

IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }

codes?: Array<string> | null

List of specific result codes from the fraud and risk screening.

correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"

One of the following:

"low_confidence"

"potential_match"

"likely_match"

"high_confidence"

correlation_score?: number | null

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

decision?: "accept" | "reject" | "review"

One of the following:

"accept"

"reject"

"review"

risk_score?: number | null

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble