---
title: "Get customer profile"
method: GET
path: "/open-api/v3/scan2pay/customer/profile/{customerId}"
tags: ["Customer"]
---

# Get customer profile

`GET /open-api/v3/scan2pay/customer/profile/{customerId}`

## Request

- Base URL: `https://api-sandbox.interlace.money`
- URL: `https://api-sandbox.interlace.money/open-api/v3/scan2pay/customer/profile/{customerId}`
- Auth: API key in header `x-access-token`

Retrieves the specified customer profile together with Scan-to-Pay
transaction-country activation statuses.

For the response structure, see the
[Customer Profile Resource](https://developer.interlace.money/docs/scan-to-pay#customer-profile-resource).

## Path parameters

- `customerId` string, required

## Response `200`

Successful operation

- ApiResultCustomerProfileRespDTO: Standard API response wrapper
  - `code` string: Business code, 000000 means success
  - `message` string: Message description
  - `data` CustomerProfileRespDTO: Response data, null if error
    - `customer` CustomerRespDTO: Response data, null if error
      - `customerId` string: Numeric string representing a 64-bit Interlace customer identifier
      - `customerEmail` string: Email address
      - `version` string: API version associated with the customer record
      - `firstName` string: First name
      - `lastName` string: Last name
      - `dateOfBirth` string: Date of birth in YYYY-MM-DD format
      - `gender` string: Gender (M/F)
      - `nationality` string: Nationality (ISO 3166-1 alpha-2)
      - `nationalId` string: Government-issued ID number
      - `idType` string: Government-issued ID type
      - `issueDate` string: ID issue date in YYYY-MM-DD format
      - `expiryDate` string: ID expiry date in YYYY-MM-DD format
      - `nationalAddress` Address: Mailing or billing address
        - `addressLine1` string, required: Primary address line (Street address / PO Box / Company name). English letters only, numbers and common symbols allowed.
        - `addressLine2` string: Secondary address line (Apartment / Suite / Unit / Building). English letters only, numbers and common symbols allowed.
        - `city` string, required: City. English letters and spaces only.
        - `state` string, required: **State / County / Province / Region**: Required for all countries. - For the US and Canada: must provide the subdivision using the two-letter code (e.g., WA for Washington State). - For other countries without a state/province, repeat the country name. - Allowed characters: English letters, numbers, and common symbols.
        - `country` string, required: Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
        - `postalCode` string, required: Postal / ZIP code of the address.
      - `mailAddress` Address: Mailing or billing address
        - `addressLine1` string, required: Primary address line (Street address / PO Box / Company name). English letters only, numbers and common symbols allowed.
        - `addressLine2` string: Secondary address line (Apartment / Suite / Unit / Building). English letters only, numbers and common symbols allowed.
        - `city` string, required: City. English letters and spaces only.
        - `state` string, required: **State / County / Province / Region**: Required for all countries. - For the US and Canada: must provide the subdivision using the two-letter code (e.g., WA for Washington State). - For other countries without a state/province, repeat the country name. - Allowed characters: English letters, numbers, and common symbols.
        - `country` string, required: Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
        - `postalCode` string, required: Postal / ZIP code of the address.
      - `frontImageId` string: Numeric string representing the uploaded image identifier for the front of the identity document
      - `backImageId` string: Numeric string representing the uploaded image identifier for the back of the identity document
      - `holdImageId` string: Numeric string representing the uploaded image identifier for the selfie holding the identity document
      - `ipAddress` string: IP address captured during customer onboarding
      - `phoneNumber` string: Phone number without the country calling code
      - `phoneCountryCode` string: International calling code, digits only, without the plus sign
      - `occupation` 'EXECUTIVE' | 'MANAGER' | 'BUSINESS_OWNER' | 'PROFESSIONAL' | 'EMPLOYEE' | 'HOMEMAKER' | 'STUDENT' | 'RETIRED' | 'UNEMPLOYED' | 'OTHER': Customer occupation classification
    - `countryActivations` CountryActivationItemRespDTO[]: Country activation statuses
      - `transactionCountry` string: Transaction country code (ISO 3166-1 alpha-2)
      - `status` string: Country activation status (PROCESSING, SUCCESS, FAILED)
      - `errorMessage` string: Reason for rejection or processing failure, if applicable
      - `missingMaterials` KycMissingMaterial[]: KYC items that must be provided or corrected before activation can be completed
        - `fieldName` string: Field name in the KYC submission payload
        - `description` string: Description of the issue
        - `issueType` string: Issue category
        - `suggestedAction` string: Recommended remediation action

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/interlace/apis/scan-to-pay.md) - [All operations](https://skmtc.dev/interlace/apis/scan-to-pay/llms.txt) - [OpenAPI document](https://skmtc.dev/interlace/apis/scan-to-pay/revisions/81f4c583068b?raw)