---
title: "Get customer"
method: GET
path: "/accounts/v2/customers/{customerId}"
tags: ["Customers"]
---

# Get customer

`GET /accounts/v2/customers/{customerId}`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/accounts/v2/customers/{customerId}`
- Auth: HTTP bearer

Use the customer ID to get customer and associated entity details.

To get a list of customer IDs, call [List account customers](ref:customersv2get).

Depending on customer, either the `person`, `company`, or `customer` (less informational fields than `person`) object is returned.

## Path parameters

- `customerId` integer, required

## Response `200`

Detailed customer and entity information associated with the given customer ID.

- object
  - `program_id` integer: Program ID
  - `account_id` integer: Account ID
  - `entity` object
    - `id` integer: Entity ID
    - `name` string: Entity name
    - `document_number` string: Document number, such as a government tax ID.
    - `registration` string: Entity registration
    - `birth_date` string, date: Entity birth date. Format = yyyy-mm-dd. For individuals, this is their birth date. For companies, this is the business registration date.
    - `gender` 'F' | 'M' | '': Gender
    - `mothers_name` string: Mother's name
    - `marital_status` 'SINGLE' | 'MARRIED' | 'DIVORCED' | 'WIDOWER': Marital status
    - `pep` boolean: Is this person a Politically Exposed Person (PEP)? Pismo doesn't do anything differently for a PEP, this is just additional account information. Default is `false`.
    - `person` Person2: Either this or the `company` object is **REQUIRED**. Pass one or the other but not both.
      - `nationality` string: Nationality
      - `city_of_birth` string: Birth city
      - `state_of_birth` string: Birth state
      - `country_of_birth` string: Birth country
      - `other_id_number` string: Another ID number
      - `document_type` string: Document type. Free-form field, not an enum.
      - `document_issued_by` string: Document issuer
      - `document_issued_at` string: Document issuer location. This is a free-form field, not an ISO standard.
      - `document_issued_date` string: Date document was issued. Format = dd/mm/yyyy.
      - `fathers_name` string: Father's name
      - `occupation` string: Person's occupation
      - `assets` number, float: Assets
      - `income` number, float: Person's income
      - `net_worth` number, float: Person's net worth
    - `company` Company2
      - `company_name` string: Company's legal name
      - `registration_number` string: Company's registration number with local authorities
      - `activity` string: Company's general field of activity
      - `company_type` string: Company type
      - `company_format` string: Company social type
      - `company_constitution_date` string: Company constitution date. Format = dd/MM/yyyy.
      - `occupation` string: Company representative's occupation
      - `annual_revenues` number, float: Company annual revenues (monthly billing average)
      - `type` string: Company's business relations type
      - `number_of_partners` integer: Number of company partners
      - `perc_ownership` number, float: Company percentage ownership
      - `fiscal_situation` string: Company's fiscal situation.
      - `debt` number, float: Company's debt
      - `income` integer: Company's income
      - `net_worth` integer: Company's net worth
      - `partners` Partner[]: Company partners
        - `name` string: Name - person or company name
        - `nickname` string: Nickname.
        - `printed_name` string: This field is **DEPRECATED**. Name to be printed on the card. Punctuation, special characters, and connectors (da/das/de/do/dos/e) are always removed. This field's maximum length is 25, but you can set it to a lower value at the program level with the `Max name length on physical card` program parameter. If `printed_name` is null, the Pismo platform uses `social_name`. If `social_name` is null, the Pismo platform uses the customer's entity name. For more information on the customer object, refer to [Core objects](doc:setup-overview#customer). The Pismo platform gets the name for program parameter `TAMANHO MAX NOME EMBOSSADO` (max size name embossed).
        - `social_name` string: Social name.
        - `email` string, email: Email address.
        - `document_number` string: Document number, such as a government tax ID.
        - `mothers_name` string: Mother's name
        - `gender` 'F' | 'M' | '': Gender
        - `birth_date` string: Birth date. Format = dd/mm/yyyy.
        - `city_of_birth` string: Birth city
        - `state_of_birth` string: Birth state
        - `country_of_birth` string: Birth country
        - `fathers_name` string: Father's name
        - `marital_status` 'SINGLE' | 'MARRIED' | 'DIVORCED' | 'WIDOWER': Marital status
  - `customer` object
    - `id` integer: Customer ID
    - `printed_name` string: This field is **DEPRECATED**. Name to be printed on the card. Punctuation, special characters, and connectors (da/das/de/do/dos/e) are always removed. This field's maximum length is 25, but you can set it to a lower value at the program level with the `Max name length on physical card` program parameter. If `printed_name` is null, the Pismo platform uses `social_name`. If `social_name` is null, the Pismo platform uses the customer's entity name. For more information on the customer object, refer to [Core objects](doc:setup-overview#customer). The Pismo platform gets the name for program parameter `TAMANHO MAX NOME EMBOSSADO` (max size name embossed).
    - `social_name` string: Social name.
    - `nickname` string: Nickname.
    - `is_owner` boolean: Is the customer the account owner?
    - `is_active` boolean: Is customer active or not active? If `is_active` is null in this request, the Pismo platform doesn't overwrite the existing value.
    - `email` string, email: Email address.
    - `addresses` object[]
      - `address_id` integer: Address ID
      - `type` 'RESIDENTIAL' | 'COMMERCIAL' | 'OTHER': Address type
    - `phones` object[]
      - `phone_id` integer: Phone ID
      - `type` 'MOBILE' | 'RESIDENTIAL' | 'COMMERCIAL': Phone type.

## Other responses

- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/pismo/apis/core-platform-accounts.md) - [All operations](https://skmtc.dev/pismo/apis/core-platform-accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/core-platform-accounts/revisions/0b24a835073b?raw)