--- title: "Get customer details" method: GET path: "/customers/{identifier}" tags: ["Customers"] --- # Get customer details `GET /customers/{identifier}` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/customers/{identifier}` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `vault`, `vault:customers` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the details of a customer and their payment instruments. ## Path parameters - `identifier` union, required - string - string, email ## Response `200` Customer retrieved successfully - RetrieveCustomerResponse: Customer retrieved successfully - `id` string, required: The customer's unique identifier - `email` string, email, required: The customer's email address - `default` string: The ID for this customer's default instrument - `name` string: The customer's name - `phone` PhoneNumber: A phone number - `country_code` string: The international country calling code. Required if `source.type` is `tamara`. - `number` string: The phone number. Required if `source.type` is `tamara`. - `metadata` object: A set of key-value pairs that is attached to a customer - `instruments` RetrieveCustomerInstrumentResponse[]: The details of the instruments linked to this customer - union - object: Bank account details - `type` string, required: The instrument type - `id` string, required: The unique identifier of the payment source or destination that can be used later for payments - `fingerprint` string, required: A token that can uniquely identify this instrument across all customers - `account_type` 'savings' | 'current' | 'cash': The type of account - `account_number` string: Number (which can contain letters) that identifies the account - `bank_code` string: Code that identifies the bank - `branch_code` string: Code that identifies the bank branch - `iban` string: Internationally agreed standard for identifying bank account - `bban` string: The combination of bank code and/or branch code and account number - `swift_bic` string: 8 or 11 character code which identifies the bank or bank branch - `currency` string, required: The three-letter ISO currency code of the account's currency - `country` string, required: The two-letter ISO country code of where the account is based - `account_holder` union: The bank account holder details. Having accurate and complete data improves payout performance (increases success rate and the prevents delays). - object: Store a previously tokenized instrument - `type` 'individual' | 'corporate' | 'government', required: The type of the legal account holder. - `first_name` string, required: The legal first name of the account holder. - `last_name` string, required: The legal last name of the account holder. - `tax_id` string: The legal account holder's tax number or reference. - `date_of_birth` string, date: The account holder's date of birth in a `YYYY-MM-DD` format. Strongly recommended where available. - `country_of_birth` string: The two-letter ISO country code of the account holder's country of birth. - `residential_status` 'resident' | 'non_resident': The account holder's residential status. - `billing_address` Address, required - … - `phone` PhoneNumber: A phone number - … - `identification` object: The account holder's government document identification. For example, the social security number (SSN). - … - object: Store a previously tokenized instrument - `type` 'individual' | 'corporate' | 'government', required: The type of the legal account holder. - `company_name` string, required: The full legal name of a registered company that holds the account. - `tax_id` string: The legal account holder's tax number or reference. - `billing_address` Address - … - object: Store a previously tokenized instrument - `type` 'individual' | 'corporate' | 'government', required: The type of the legal account holder. - `company_name` string, required: The full legal name of a registered company that holds the account. - `tax_id` string: The legal account holder's tax number or reference. - `billing_address` Address - … - `bank` BankDetails: Details of the bank - `name` string: The bank's name - `branch` string: The bank branch's name - `address` Address - `address_line1` string: The first line of the address. - `address_line2` string: The second line of the address.

For SEPA payments, this value has a maximum length of 10 characters. - `city` string: The address city. - `state` string: The state or province of the address country ISO 3166-2 code (for example: CA for California in the United States). - `zip` string: The address zip or postal code. - `country` string: The two-letter ISO country code of the address. - `metadata` InstrumentMetadata: A set of key-value pairs that you can attach to a card token or payment instrument to store your own references, such as a customer document number or partner reference. You can include a maximum of 20 key-value pairs. Each key must be between 1 and 100 characters long, and each value can be up to 100 characters long. Keys and values must be strings. Nested objects, arrays, numbers, booleans, and `null` values are not supported. Metadata is stored encrypted, and is returned exactly as you provided it. Keys are case-sensitive. Do not store card details, credentials, or personal data you do not have consent to store in metadata. - object: card instrument response - `type` string, required: The instrument type - `id` string, required: The unique identifier of the payment source or destination that can be used later for payments - `fingerprint` string, required: A token that can uniquely identify this instrument across all customers - `expiry_month` integer, required: The expiry month - `expiry_year` integer, required: The expiry year - `scheme` string: The card scheme - `last4` string, required: The last four digits of the card number - `bin` string, required: The card issuer's bank identification number (BIN) - `card_type` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'CHARGE': The card type - `card_category` 'CONSUMER' | 'COMMERCIAL': The card category - `issuer` string: The name of the card issuer - `issuer_country` string: The card issuer's country (two-letter ISO code) - `product_id` string: The issuer/card scheme product identifier - `product_type` string: The issuer/card scheme product type - `account_holder` object: The account holder details - `first_name` string: The first name of the account holder - `last_name` string: The last name of the account holder - `billing_address` Address - `address_line1` string: The first line of the address. - `address_line2` string: The second line of the address.

For SEPA payments, this value has a maximum length of 10 characters. - `city` string: The address city. - `state` string: The state or province of the address country ISO 3166-2 code (for example: CA for California in the United States). - `zip` string: The address zip or postal code. - `country` string: The two-letter ISO country code of the address. - `phone` PhoneNumber: A phone number - `country_code` string: The international country calling code. Required if `source.type` is `tamara`. - `number` string: The phone number. Required if `source.type` is `tamara`. - `card_wallet_type` 'googlepay' | 'applepay': The type of digital wallet used for the card. - `metadata` InstrumentMetadata: A set of key-value pairs that you can attach to a card token or payment instrument to store your own references, such as a customer document number or partner reference. You can include a maximum of 20 key-value pairs. Each key must be between 1 and 100 characters long, and each value can be up to 100 characters long. Keys and values must be strings. Nested objects, arrays, numbers, booleans, and `null` values are not supported. Metadata is stored encrypted, and is returned exactly as you provided it. Keys are case-sensitive. Do not store card details, credentials, or personal data you do not have consent to store in metadata. - object: card instrument response - `type` string, required: The instrument type - `id` string, required: The unique identifier of the payment source or destination. You can use the `id` in future payments. - `fingerprint` string, required: A token that can uniquely identify this instrument across all customers. - `created_on` string, date-time, required: The date and time the instrument was created. - `modified_on` string, date-time, required: The date and time the instrument was last modified. - `vault_id` string, required: The Vault ID currently attached to the instrument. - `instrument_data` object, required: The details of the bank account - `account_type` 'savings' | 'checking', required: The type of Direct Debit account - `account_number` string, required: The account number of the Direct Debit account - `bank_code` string, required: The bank code of the Direct Debit account - `currency` string, required: The currency of the account - `country` string, required: The country of the account - `account_holder` object, required: The account holder details - `first_name` string, required: First name. Required for individual account holder type - `last_name` string, required: Last name. Required for individual account holder type - `company_name` string, required: Company name. Required for corporate account holder type - `type` 'individual' | 'corporate', required: Account holder type - `customer` RetrieveInstrumentCustomerResponse: Stored customer details - `id` string, required: The customer's unique identifier. This can be passed as a source when making a payment. - `email` string: The customer's email address - `name` string: The customer's name - `default` boolean: This will be true if this instrument is set as the default for the customer - `metadata` object: The metadata stored with the customer. This is separate from the payment instrument's `metadata` object. - object: card instrument response - `type` string, required: The instrument type - `id` string, required: The unique identifier of the payment source or destination. You can use the `id` in future payments. - `fingerprint` string, required: A token that can uniquely identify this instrument across all customers. - `created_on` string, date-time, required: The date and time the instrument was created. - `modified_on` string, date-time, required: The date and time the instrument was last modified. - `vault_id` string, required: The Vault ID currently attached to the instrument. - `instrument_data` object: The details of the SEPA mandate. - `account_number` string, required: The International Bank Account Number (IBAN) of the account. - `country` string, required: The country of the account. - `currency` string, required: The currency of the account. - `payment_type` 'recurring' | 'regular', required: The type of payment. - `mandate_id` string, required: The mandate ID. If this value was not provided when the instrument was created, it may take up to five seconds for the generated mandate ID to be available. - `date_of_signature` string, date, required: The date the mandate was signed. If `mandate_id` was not provided when the instrument was created, it may take up to five seconds for the generated date of signature to be available. - `account_holder` object: The account holder's details. - `first_name` string, required: The first name of the account holder. - `last_name` string, required: The last name of the account holder. - `billing_address` object, required: The billing address of the account holder. - `address_line1` string, required: The first line of the address. - `address_line2` string, required: The second line of the address. - `city` string, required: The address city. - `zip` string, required: The address ZIP or postal code. - `country` string, required: The address country. - `customer` RetrieveInstrumentCustomerResponse: Stored customer details - `id` string, required: The customer's unique identifier. This can be passed as a source when making a payment. - `email` string: The customer's email address - `name` string: The customer's name - `default` boolean: This will be true if this instrument is set as the default for the customer - `metadata` object: The metadata stored with the customer. This is separate from the payment instrument's `metadata` object. ## Other responses - `401`: Unauthorized - `404`: Customer not found --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)