Authorizations
Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.
Headers
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Optional client generated value to use for idempotent requests.
10 - 40
Path Parameters
Body
The first name of the representative.
"Ron"
The last name of the representative.
"Swanson"
The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
"1980-01-01"
The last 4 digits of the representative's Social Security Number.
"1234"
The email address of the representative.
"ron.swanson@pawnee.com"
The mobile phone number of the representative.
"+12128675309"
Unique identifier for the representative 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 represetative in a structured format.
Response
OK
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