---
title: "Get customer by ID"
method: GET
path: "/customers/{id}"
---

# Get customer by ID

`GET /customers/{id}`

## Request

- Base URL: `https://api.open-finance.ai/v3/loans`
- URL: `https://api.open-finance.ai/v3/loans/customers/{id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.open-finance.ai/oauth/token` scopes: `read:customers`

## Path parameters

- `id` string, required

## Response `200`

Fetched successfully. The 'raw' field will be included only if the user has admin privileges.

- object
  - `count` number: The number of items returned
  - `nextPage` string: URL for the next page if available
  - `items` Customer[]: Array of customer items
    - `customerId` string: The unique identifier of the customer
    - `orgId` string: Organization ID the customer belongs to
    - `userId` string: User ID associated with the customer
    - `advisorId` string: Advisor ID associated with the customer
    - `accountId` string: Salesforce account ID associated with the customer
    - `psuIdType` string: Type of PSU ID
    - `numberOfConnections` number: Number of connections associated with the customer
    - `firstName` string: Customer's first name
    - `lastName` string: Customer's last name
    - `nationalId` string: Customer's national ID
    - `nationalIdIssueDate` string, date: The date when the national ID was issued
    - `email` string: Customer's email address
    - `phoneNumber` string: Customer's phone number
    - `birthDate` string, date: Customer's birth date
    - `businessId` string: Business ID if the customer is a business
    - `businessCityName` string: City name of the business
    - `businessStreetName` string: Street name of the business
    - `businessStreetNumber` string: Street number of the business
    - `businessHouseNumber` string: House number of the business
    - `businessApartmentNumber` string: Apartment number of the business
    - `businessZipCode` string: Zip code of the business
    - `buisnessPostOfficeBox` string: Post office box of the business
    - `businessPhoneNumber` string: Business phone number
    - `businessName` string: Business name if the customer is a business
    - `businessType` string: Type of business
    - `businessEstablishedDate` string, date: The date when the business was established
    - `businessNumberOfOwners` number: Number of owners of the business
    - `businessNumberOfEmployees` number: Number of employees in the business
    - `businessIncomeFromLastFinancialStatement` number: Income from the last financial statement
    - `businessWebsiteUrl` string: URL of the business website
    - `activityArea` string: Area of business activity
    - `geoArea` string: Geographical area of the business
    - `customerReqFiles` RequiredFile[]
      - `fileName` string
      - `apiName` string
      - `label` object
        - `en` string
        - `he` string
      - `isRequired` boolean
    - `customerOtherFiles` RecordedFile[]
      - `url` string: URL to access the file from S3
      - `timestamp` number: Timestamp of the file
      - `fileName` string: Name of the file
      - `bucketPath` string: S3 bucket path where the file is stored
      - `bucketFileName` string: Name of the file in the S3 bucket
      - `processType` 'PCN' | '6111' | 'OSH': Type of process the file is associated with
    - `hasFiles` boolean: Indicates if the customer has files
    - `hasReports` boolean: Indicates if the customer has reports
    - `hasOsh` boolean: Indicates if the customer has OSH
    - `hasEnrichedData` boolean: Indicates if the customer has enriched data
    - `hasConnections` boolean: Indicates if the customer has connections
    - `createdAt` string, date-time: The date when the customer was created
  - `raw` RawCustomer[]: Array of raw customer data. This field is returned only for admin users.
    - `PK` string: Primary key of the customer
    - `SK` string: Sort key of the customer
    - `orgId` string: Organization ID
    - `userId` string: User ID associated with the customer
    - `advisorId` string: Advisor ID associated with the customer
    - `geoId` string: Geographical ID
    - `customerId` string: Unique customer ID
    - `customerType` 'BUSINESS' | 'PRIVATE': Customer type
    - `customerPsuIdType` string: Type of PSU ID
    - `customerNumberOfConnections` number: Number of connections the customer has
    - `customerNationalId` string: National ID of the customer
    - `customerNationalIdIssueDate` string, date: Issue date of the national ID
    - `customerNationalIdExpiryDate` string, date: Expiry date of the national ID
    - `customerFirstName` string: Customer's first name
    - `customerLastName` string: Customer's last name
    - `customerEmail` string: Customer's email address
    - `customerPhone` string: Customer's phone number
    - `customerBirthDate` string, date: Customer's birth date
    - `customerBusinessId` string: Business ID if the customer is a business
    - `customerBusinessName` string: Business name if the customer is a business
    - `customerBusinessEstablishedDate` string, date: Date when the business was established
    - `customerBusinessType` string: Type of business
    - `customerActivityArea` string: Area of activity
    - `customerGeoArea` string: Geographical area
    - `customerCityName` string: City name
    - `customerCityNumber` number: City number
    - `customerStreetName` string: Street name
    - `customerStreetNumber` number: Street number
    - `customerHouseNumber` number: House number
    - `customerApartmentNumber` number: Apartment number
    - `customerPostOfficeBox` number: Post office box number
    - `customerZipCode` number: Zip code
    - `customerBusinessNumberOfEmployees` number: Number of employees in the business
    - `customerIncomeFromLastFinancialStatement` number: Income from the last financial statement
    - `customerWebsiteUrl` string: URL of the business website
    - `customerBusinessNumberOfOwners` number: Number of owners of the business
    - `customerReqFiles` RequiredDocObject[]: Array of required document objects
      - `apiName` string
      - `fileName` string
      - `label` object
        - `he` string
        - `en` string
      - `isRequired` boolean
    - `customerOtherFiles` OtherDocRecorded[]: Array of other recorded document objects
      - `timestamp` number: Timestamp of when the document was recorded
      - `fileName` string: Name of the file
      - `bucketPath` string: S3 bucket path where the file is stored
      - `bucketFileName` string: Name of the file in the S3 bucket
      - `processType` 'PCN' | '6111' | 'OSH' | 'ESSNA': Type of process the file is associated with
      - `url` string: URL to access the file
    - `customerHasFiles` boolean: Indicates if the customer has files
    - `customerHasReports` boolean: Indicates if the customer has reports
    - `customerHasEnrichedData` boolean: Indicates if the customer has enriched data
    - `customerHasOsh` boolean: Indicates if the customer has OSH
    - `customerHasCreditReport` boolean: Indicates if the customer has a credit report
    - `customerHasConnections` boolean: Indicates if the customer has connections
    - `customerVerifoneData` DataHarborBusinessRequest
      - `userId` string
      - `reportProducingDate` string, date
      - `qa` object
        - `id` string
        - `referenceDate` string
        - `CustomerType` 'Loaner' | 'Guarantor'
        - `LoanAmount` number
      - `groupLishkaScore` object
        - `id` string
        - `referenceDate` string
        - `scoreGroupLishka` number
      - `verifoneData` object
        - `customer` object
          - `businessNumber` string
          - `businessName` string
          - `contactNumberId` string
          - `contactName` string
          - `groupCode` number
          - `groupName` string
          - `email` string
          - `phone1` string
          - `phone2` string
          - `cellular` string
          - `city` string
          - `street` string
          - `zipCode` string
    - `customerDnbReport` DBDnbBusinessKeys
      - `dnbDuns` number
      - `dnbRegis` string
      - `dnbPhoneNumber` string
      - `dnbType` string
      - `dnbEmail` string
      - `dnbUrl` string
      - `dnbName` string
      - `dnbEnglishName` string
      - `dnbAkaName` string
      - `dnbAkaEnglishName` string
      - `dnbAdditionalName` string
      - `dnbCity` string
      - `dnbStreet` string
      - `dnbStreetNumber` string
      - `dnbZip` string
      - `dnbTrendCode` number
      - `dnbTrendDesc` string
      - `dnbGeneralCode` number
      - `dnbGeneralDesc` string
      - `dnbRank` string
      - `dnbRankDesc` string
      - `dnbPrevRank` string
      - `dnbPrevRankDesc` string
      - `dnbMaxCreditAmount` string
      - `dnbCompanyScore` number
      - `dnbSicScore` number
      - `dnbScoreCurrentDate` string
      - `dnbCompanyEntityCode` number
      - `dnbCompanyEntityCodeDescription` string
      - `dnbComapnyLegalStatusCode` number
      - `dnbCompanyLegalStatusDescription` string
    - `customerDataHarbor` DBDataHarborBusinessKeys
      - `dhCompFinalGroup` string
      - `dhCompFinalScore` string
      - `dhCompGO` string
      - `dhDB10IncomeGrowth` string
      - `dhDB11RelatedCompanies` string
      - `dhDB12Properties` string
      - `dhDB1LegalStatus` string
      - `dhDB2EconomyBranch` string
      - `dhDB3Seniority` string
      - `dhDB4Alerts` string
      - `dhDB5RelatedCompanyAlerts` string
      - `dhDB6SuppliersReports` string
    - `createdAt` string, date-time: Timestamp when the customer was created
    - `updatedAt` string, date-time: Timestamp when the customer was last updated
    - `customerDistanceFromFireStation` object: Distance from fire station
      - `text` string
      - `value` number
    - `customerDurationFromFireStation` object: Duration from fire station
      - `text` string
      - `value` number

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `500`: Internal server error

---

[API](https://skmtc.dev/open-finance/apis/loans.md) - [All operations](https://skmtc.dev/open-finance/apis/loans/llms.txt) - [OpenAPI document](https://skmtc.dev/open-finance/apis/loans/revisions/915c69e62042?raw)