Lookup a customer

customers.get(, ) -> CustomerV1

get/v1/customers/{id}

Retrieves the details of an existing customer. Supply the unique customer ID that was returned from your 'create customer' request, and Straddle will return the corresponding customer information.

ParametersExpand Collapse

id: str

correlation_id: Optional[str]

request_id: Optional[str]

straddle_account_id: Optional[str]

ReturnsExpand Collapse

class CustomerV1: …

data: Data

id: str

Unique identifier for the customer.

formatuuid

created_at: datetime

Timestamp of when the customer record was created.

formatdate-time

email: str

The customer's email address.

formatemail

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]

Accepts one of the following:

"pending"

"review"

"verified"

"inactive"

"rejected"

type: Literal["individual", "business"]

Accepts one of the following:

"individual"

"business"

updated_at: datetime

Timestamp of the most recent update to the customer record.

formatdate-time

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).

maxLength100

city: str

City, district, suburb, town, or village.

maxLength100

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).

maxLength100

compliance_profile: Optional[DataComplianceProfile]

PII required to trigger Patriot Act compliant KYC verification.

Accepts one of the following:

class DataComplianceProfileIndividualComplianceProfile: …

PII required to trigger Patriot Act compliant KYC verification.

dob: Optional[date]

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

formatdate

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'.

name: str

email: Optional[str]

phone: Optional[str]

website: Optional[str]

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

formaturi

config: Optional[DataConfig]

processing_method: Optional[Literal["inline", "background", "skip"]]

Accepts one of the following:

"inline"

"background"

"skip"

sandbox_outcome: Optional[Literal["standard", "verified", "rejected", "review"]]

Accepts one of the following:

"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.

minLength1

formatipv4

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.

meta: ResponseMetadata

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: Literal["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.

Accepts one of the following:

"object"

"array"

"error"

"none"

Lookup a customer

from straddle import Straddle

client = Straddle(
    api_key="My API Key",
)
customer_v1 = client.customers.get(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(customer_v1.data)

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "email": "ron.swanson@pawnee.com",
    "name": "Ron Swanson",
    "phone": "+12128675309",
    "status": "pending",
    "type": "individual",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "address": {
      "address1": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "address2": "Apt 1"
    },
    "compliance_profile": {
      "dob": "2019-12-27",
      "ssn": "***-**-****"
    },
    "config": {
      "processing_method": "inline",
      "sandbox_outcome": "standard"
    },
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "external_id",
    "metadata": {
      "foo": "string"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}

Returns Examples

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "email": "ron.swanson@pawnee.com",
    "name": "Ron Swanson",
    "phone": "+12128675309",
    "status": "pending",
    "type": "individual",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "address": {
      "address1": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "address2": "Apt 1"
    },
    "compliance_profile": {
      "dob": "2019-12-27",
      "ssn": "***-**-****"
    },
    "config": {
      "processing_method": "inline",
      "sandbox_outcome": "standard"
    },
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "external_id",
    "metadata": {
      "foo": "string"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}