## Lookup a customer

`client.customers.get(stringid, CustomerGetParamsparams?, RequestOptionsoptions?): 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.

### Parameters

- `id: string`

- `params: CustomerGetParams`

  - `correlationID?: string`

    Optional client generated identifier to trace and debug a series of requests.

  - `requestID?: string`

    Optional client generated identifier to trace and debug a request.

  - `straddleAccountID?: string`

    For use by platforms to specify an account id and set scope of a request.

### Returns

- `CustomerV1`

  - `data: Data`

    - `id: string`

      Unique identifier for the customer.

    - `created_at: string`

      Timestamp of when the customer record was created.

    - `email: string`

      The customer's email address.

    - `name: string`

      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`

      - `"pending"`

      - `"review"`

      - `"verified"`

      - `"inactive"`

      - `"rejected"`

    - `type: "individual" | "business"`

      - `"individual"`

      - `"business"`

    - `updated_at: string`

      Timestamp of the most recent update to the customer record.

    - `address?: CustomerAddressV1 | 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).

      - `city: string`

        City, district, suburb, town, or village.

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

    - `compliance_profile?: IndividualComplianceProfile | BusinessComplianceProfile | null`

      PII required to trigger Patriot Act compliant KYC verification.

      - `IndividualComplianceProfile`

        PII required to trigger Patriot Act compliant KYC verification.

        - `dob: string | null`

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

        - `ssn: string | null`

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

      - `BusinessComplianceProfile`

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

          - `name: string`

          - `email?: string | null`

          - `phone?: string | null`

        - `website?: string | null`

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

    - `config?: Config`

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

        - `"inline"`

        - `"background"`

        - `"skip"`

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

        - `"standard"`

        - `"verified"`

        - `"rejected"`

        - `"review"`

    - `device?: Device`

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

    - `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`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

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

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```typescript
import Straddle from '@straddlecom/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

const customerV1 = await client.customers.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(customerV1.data);
```

#### Response

```json
{
  "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"
}
```