Update a customer
Use this endpoint to update an existing customer.
Updating more than two fields (not including metadata
) within a 24 hour period will trigger a new identity score.
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
Body
The customer's email address.
The customer's full name or business name.
The customer's phone number in E.164 format.
pending
, review
, verified
, inactive
, rejected
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
Compliance profile for individual customers
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.
Response
Metadata about the API request, including an identifier and timestamp.
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