Customers
Update a customer
Delete a customer
List customers
Unmask customer data
ModelsExpand Collapse
class CustomerAddressV1: …
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
address1: str
Primary address line (e.g., street, PO Box).
city: str
City, district, suburb, town, or village.
state: str
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
class CustomerSummaryPagedV1: …
data: List[Data]
id: str
Unique identifier for the customer.
created_at: datetime
Timestamp of when the customer record was created.
email: str
The customer's email address.
name: str
Full name of the individual or business name.
phone: str
The customer's phone number in E.164 format.
status: Literal["pending", "review", "verified", 2 more]
type: Literal["individual", "business"]
updated_at: datetime
Timestamp of the most recent update to the customer record.
external_id: Optional[str]
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
meta: Meta
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
max_page_size: int
Maximum allowed page size for this endpoint.
page_number: int
Page number for paginated results.
page_size: int
Number of items per page in this response.
sort_by: str
The field that the results were sorted by.
sort_order: Literal["asc", "desc"]
total_pages: int
The number of pages available.
response_type: Literal["object", "array", "error", "none"]
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
class CustomerUnmaskedV1: …
data: Data
id: str
Unique identifier for the customer.
created_at: datetime
Timestamp of when the customer record was created.
email: str
The customer's email address.
name: str
Full name of the individual or business name.
phone: str
The customer's phone number in E.164 format.
status: Literal["pending", "review", "verified", 2 more]
type: Literal["individual", "business"]
updated_at: datetime
Timestamp of the most recent update to the customer record.
address: Optional[CustomerAddressV1]
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
address1: str
Primary address line (e.g., street, PO Box).
city: str
City, district, suburb, town, or village.
state: str
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
compliance_profile: Optional[DataComplianceProfile]
Individual PII data required to trigger Patriot Act compliant KYC verification.
class DataComplianceProfileIndividualComplianceProfile: …
Individual PII data required to trigger Patriot Act compliant KYC verification.
dob: Optional[date]
Date of birth (YYYY-MM-DD). Required for Patriot Act-compliant KYC verification.
ssn: Optional[str]
Social Security Number (format XXX-XX-XXXX). Required for Patriot Act-compliant KYC verification.
class DataComplianceProfileBusinessComplianceProfile: …
Business registration data required to trigger Patriot Act compliant KYB verification.
ein: Optional[str]
Employer Identification Number (format XX-XXXXXXX). Required for Patriot Act-compliant KYB verification.
legal_business_name: Optional[str]
Official registered business name as listed with the IRS. This value will be matched against the 'legal_business name'.
representatives: Optional[List[DataComplianceProfileBusinessComplianceProfileRepresentative]]
A list of people related to the company. Only valid where customer type is 'business'.
website: Optional[str]
Official business website URL. Optional but recommended for enhanced KYB.
config: Optional[DataConfig]
processing_method: Optional[Literal["inline", "background", "skip"]]
sandbox_outcome: Optional[Literal["standard", "verified", "rejected", "review"]]
device: Optional[DeviceUnmaskedV1]
ip_address: str
The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.
external_id: Optional[str]
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
metadata: Optional[Dict[str, str]]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.
Metadata about the API request, including an identifier and timestamp.
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
response_type: Literal["object", "array", "error", "none"]
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
class CustomerV1: …
data: Data
id: str
Unique identifier for the customer.
created_at: datetime
Timestamp of when the customer record was created.
email: str
The customer's email address.
name: str
Full name of the individual or business name.
phone: str
The customer's phone number in E.164 format.
status: Literal["pending", "review", "verified", 2 more]
type: Literal["individual", "business"]
updated_at: datetime
Timestamp of the most recent update to the customer record.
address: Optional[CustomerAddressV1]
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
address1: str
Primary address line (e.g., street, PO Box).
city: str
City, district, suburb, town, or village.
state: str
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
compliance_profile: Optional[DataComplianceProfile]
PII required to trigger Patriot Act compliant KYC verification.
class DataComplianceProfileIndividualComplianceProfile: …
PII required to trigger Patriot Act compliant KYC verification.
dob: Optional[date]
Masked date of birth in ****-- format.
ssn: Optional[str]
Masked Social Security Number in the format --***.
class DataComplianceProfileBusinessComplianceProfile: …
Business registration data required to trigger Patriot Act compliant KYB verification.
ein: Optional[str]
Masked Employer Identification Number in the format -*****
legal_business_name: Optional[str]
The official registered name of the business. This name should be correlated with the ein value.
representatives: Optional[List[DataComplianceProfileBusinessComplianceProfileRepresentative]]
A list of people related to the company. Only valid where customer type is 'business'.
website: Optional[str]
Official business website URL. Optional but recommended for enhanced KYB.
config: Optional[DataConfig]
processing_method: Optional[Literal["inline", "background", "skip"]]
sandbox_outcome: Optional[Literal["standard", "verified", "rejected", "review"]]
device: Optional[DataDevice]
ip_address: str
The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.
external_id: Optional[str]
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
metadata: Optional[Dict[str, str]]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.
Metadata about the API request, including an identifier and timestamp.
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
response_type: Literal["object", "array", "error", "none"]
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
class DeviceUnmaskedV1: …
ip_address: str
The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.
CustomersReview
Review a customer's identity results
Update a customer's verification status
Update a customer's identity decision
ModelsExpand Collapse
class CustomerReviewV1: …
data: Data
customer_details: DataCustomerDetails
id: str
Unique identifier for the customer.
created_at: datetime
Timestamp of when the customer record was created.
email: str
The customer's email address.
name: str
Full name of the individual or business name.
phone: str
The customer's phone number in E.164 format.
status: Literal["pending", "review", "verified", 2 more]
type: Literal["individual", "business"]
updated_at: datetime
Timestamp of the most recent update to the customer record.
address: Optional[CustomerAddressV1]
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
address1: str
Primary address line (e.g., street, PO Box).
city: str
City, district, suburb, town, or village.
state: str
Two-letter state code.
zip: str
Zip or postal code.
address2: Optional[str]
Secondary address line (e.g., apartment, suite, unit, or building).
compliance_profile: Optional[DataCustomerDetailsComplianceProfile]
PII required to trigger Patriot Act compliant KYC verification.
class DataCustomerDetailsComplianceProfileIndividualComplianceProfile: …
PII required to trigger Patriot Act compliant KYC verification.
dob: Optional[date]
Masked date of birth in ****-- format.
ssn: Optional[str]
Masked Social Security Number in the format --***.
class DataCustomerDetailsComplianceProfileBusinessComplianceProfile: …
Business registration data required to trigger Patriot Act compliant KYB verification.
ein: Optional[str]
Masked Employer Identification Number in the format -*****
legal_business_name: Optional[str]
The official registered name of the business. This name should be correlated with the ein value.
representatives: Optional[List[DataCustomerDetailsComplianceProfileBusinessComplianceProfileRepresentative]]
A list of people related to the company. Only valid where customer type is 'business'.
website: Optional[str]
Official business website URL. Optional but recommended for enhanced KYB.
config: Optional[DataCustomerDetailsConfig]
processing_method: Optional[Literal["inline", "background", "skip"]]
sandbox_outcome: Optional[Literal["standard", "verified", "rejected", "review"]]
device: Optional[DataCustomerDetailsDevice]
ip_address: str
The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.
external_id: Optional[str]
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
metadata: Optional[Dict[str, str]]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.
identity_details: Optional[DataIdentityDetails]
breakdown: DataIdentityDetailsBreakdown
Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.
address: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_evaluation: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_identification: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_validation: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
email: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
fraud: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
phone: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
synthetic: Optional[IdentityVerificationBreakdownV1]
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
created_at: datetime
Timestamp of when the review was initiated.
decision: Literal["accept", "reject", "review"]
review_id: str
Unique identifier for the review.
updated_at: datetime
Timestamp of the most recent update to the review.
kyc: Optional[DataIdentityDetailsKYC]
validations: DataIdentityDetailsKYCValidations
Boolean values indicating the result of each validation in the KYC process.
codes: Optional[List[str]]
List of specific result codes from the KYC screening process.
decision: Optional[Literal["accept", "reject", "review"]]
messages: Optional[Dict[str, str]]
Dictionary of all messages from the customer verification process.
network_alerts: Optional[DataIdentityDetailsNetworkAlerts]
alerts: Optional[List[str]]
Any alerts or flags raised during the consortium alert screening.
codes: Optional[List[str]]
List of specific result codes from the consortium alert screening.
decision: Optional[Literal["accept", "reject", "review"]]
reputation: Optional[DataIdentityDetailsReputation]
codes: Optional[List[str]]
Specific codes related to the Straddle reputation screening results.
decision: Optional[Literal["accept", "reject", "review"]]
insights: Optional[DataIdentityDetailsReputationInsights]
watch_list: Optional[DataIdentityDetailsWatchList]
codes: Optional[List[str]]
Specific codes related to the Straddle watchlist screening results.
decision: Optional[Literal["accept", "reject", "review"]]
matched: Optional[List[str]]
Information about any matches found during screening.
matches: Optional[List[DataIdentityDetailsWatchListMatch]]
Information about any matches found during screening.
correlation: Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]
list_name: str
The name of the list the match was found.
match_fields: List[str]
Data fields that matched.
urls: List[str]
Relevent Urls to review.
Metadata about the API request, including an identifier and timestamp.
api_request_id: str
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: datetime
Timestamp for this API request, useful for troubleshooting.
response_type: Literal["object", "array", "error", "none"]
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
class IdentityVerificationBreakdownV1: …
codes: Optional[List[str]]
List of specific result codes from the fraud and risk screening.
correlation: Optional[Literal["low_confidence", "potential_match", "likely_match", "high_confidence"]]
correlation_score: Optional[float]
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: Optional[Literal["accept", "reject", "review"]]
risk_score: Optional[float]
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.