> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anchorage.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get customer

> Permissions required: **Read Customers**

Get a customer, including current state and any documents the partner must provide.
Document upload URLs (when present) are short-lived; always refresh via this endpoint
before uploading.



## OpenAPI

````yaml /knowledge-base/openapi/v4.yaml get /customers/{customerId}
openapi: 3.1.0
info:
  title: Anchorage Digital Account APIs (v4)
  version: 4.0.0-beta
  description: >-
    Reference for the Anchorage Digital v4 API, the surface behind Crypto as a
    Service: account management (accounts and the account tree, beneficiaries,
    freeze/unfreeze/close), balances and transactions, trusted destinations,
    orders and allocations, withdrawals, deposit instructions, deposit
    attributions, the policy engine (policies, approval keys), and supported
    asset types. Approval groups, endorsements, compliance profiles, customers
    (onboarding), fee configuration updates, interest enrollment, funding
    allocations, and destination removal are under construction and return
    mocked data only.


    Status: BETA. The v4 API is available in the sandbox only
    (https://api.anchorage-staging.com/v4) and is not available in production
    yet. The contract may change until general availability. Which endpoints are
    live, in final testing, or under construction:
    https://docs.anchorage.com/platform/developers/caas/caas-overview


    Authentication: every request carries an `Api-Access-Key` header. Every
    POST, PATCH, and DELETE additionally requires an `Idempotency-Key`, and is
    signed with `Api-Signature` (hex-encoded Ed25519 over
    `timestamp_epoch_seconds + uppercase(http_method) + request_path +
    request_body`) plus `Api-Timestamp` (unix epoch seconds).


    Pagination: list endpoints accept `after` (cursor) and `limit` (page size, 1
    to 1000, default 100) and return a `page.endCursor` to continue from. Errors
    use a common envelope with a human-readable `message`; batch endpoints
    return a result per item instead.


    Guides: https://docs.anchorage.com/platform/developers/caas/caas-overview
servers:
  - url: https://api.anchorage-staging.com/v4
security:
  - Api-Access-Key: []
tags:
  - name: Accounts
  - name: Compliance Profiles
  - name: Balances
  - name: Transactions
  - name: Trusted Destinations
  - name: Orders & Allocations
  - name: Withdrawals
  - name: Deposit Instructions
  - name: Deposit Attributions
  - name: Policies
  - name: Approval Groups
  - name: Endorsements
  - name: Customers
  - name: Asset Types
paths:
  /customers/{customerId}:
    get:
      tags:
        - Customers
      summary: Get customer
      description: >-
        Permissions required: **Read Customers**


        Get a customer, including current state and any documents the partner
        must provide.

        Document upload URLs (when present) are short-lived; always refresh via
        this endpoint

        before uploading.
      operationId: getCustomer
      parameters:
        - name: customerId
          in: path
          schema:
            type: string
            format: uuid
            example: 3486b413-93d3-4447-afce-2b9c9dc34a32
          required: true
          description: Unique identifier for the customer
      responses:
        '200':
          description: Customer details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
components:
  schemas:
    CustomerResponse:
      title: Customer Response
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Customer'
    ErrorDetails:
      title: ErrorDetails
      type: object
      properties:
        message:
          description: A human-readable message providing more details about the error.
          example: Missing required field 'amount'.
          type: string
      required:
        - message
    Customer:
      title: Customer Details
      description: >-
        The full details of a customer. The `customerType` discriminator
        indicates whether the underlying object is an individual or business
        customer.
      discriminator:
        propertyName: customerType
        mapping:
          INDIVIDUAL: '#/components/schemas/IndividualCustomer'
          BUSINESS: '#/components/schemas/BusinessCustomer'
      oneOf:
        - $ref: '#/components/schemas/IndividualCustomer'
        - $ref: '#/components/schemas/BusinessCustomer'
    IndividualCustomer:
      title: Individual Customer Details
      type: object
      description: Full details of an individual customer
      properties:
        customerId:
          description: Unique identifier for the customer
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        customerType:
          type: string
          enum:
            - INDIVIDUAL
          default: INDIVIDUAL
          description: Discriminator — always INDIVIDUAL
        documents:
          type: array
          description: Documents associated with the customer, with their current state.
          items:
            $ref: '#/components/schemas/OnboardingDocument'
        externalId:
          type: string
          description: External identifier provided by the client
        firstName:
          type: string
          description: First name of the individual
        lastName:
          type: string
          description: Last name of the individual
        dateOfBirth:
          type: string
          format: date
          description: Date of birth
        email:
          type: string
          format: email
          description: Email address
        idNumber:
          type: string
          description: Government-issued identification number
        address:
          $ref: '#/components/schemas/CustomerAddress'
        state:
          $ref: '#/components/schemas/CustomerState'
        createdAt:
          description: When the customer was created
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        updatedAt:
          description: When the customer was last updated
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
      required:
        - customerId
        - customerType
        - state
        - firstName
        - lastName
        - email
        - idNumber
        - address
        - createdAt
        - updatedAt
    BusinessCustomer:
      title: Business Customer Details
      type: object
      description: Full details of a business customer
      properties:
        customerId:
          description: Unique identifier for the customer
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        customerType:
          type: string
          enum:
            - BUSINESS
          default: BUSINESS
          description: Discriminator — always BUSINESS
        documents:
          type: array
          description: Documents associated with the customer, with their current state.
          items:
            $ref: '#/components/schemas/OnboardingDocument'
        externalId:
          type: string
          description: External identifier provided by the client
        legalName:
          type: string
          description: Legal name of the business
        dbaNames:
          type: string
          description: Doing business as names
        registrationNumber:
          type: string
          description: Business registration number
        legalStructure:
          type: string
          description: Legal structure of the business
          enum:
            - C_CORP
            - LLC
            - LLP
            - LP
            - S_CORP
            - SOLE_PROP
            - TRUST
            - NON_PROFIT
            - OTHER
        dateOfIncorporation:
          type: string
          format: date
          description: Date of incorporation
        address:
          $ref: '#/components/schemas/CustomerAddress'
        state:
          $ref: '#/components/schemas/CustomerState'
        createdAt:
          description: When the customer was created
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        updatedAt:
          description: When the customer was last updated
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
      required:
        - customerId
        - customerType
        - state
        - legalName
        - registrationNumber
        - address
        - createdAt
        - updatedAt
    OnboardingDocument:
      title: Onboarding Document
      type: object
      description: A document associated with a customer
      required:
        - documentId
        - state
      properties:
        documentId:
          type: string
          description: Unique identifier for the document
        state:
          $ref: '#/components/schemas/OnboardingDocumentState'
        signedUrl:
          type: string
          description: Signed URL for accessing the document
          nullable: true
        expiresAt:
          description: Expiration time of the signed URL
          nullable: true
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
    CustomerAddress:
      title: Customer Address
      type: object
      description: A structured postal address
      required:
        - country
      properties:
        country:
          type: string
          description: Country
        streetAddress:
          type: string
          description: Street address
          nullable: true
        city:
          type: string
          description: City
          nullable: true
        state:
          type: string
          description: State or province
          nullable: true
        postalCode:
          type: string
          description: Zip code or postal code
          nullable: true
    CustomerState:
      title: Customer State
      type: string
      description: The state of a customer onboarding application
      enum:
        - DRAFT
        - IN_PROGRESS
        - IN_REVIEW
        - APPROVED
        - REJECTED
    OnboardingDocumentState:
      title: Onboarding Document State
      type: string
      description: The state of a document
      enum:
        - PENDING
        - UPLOADED
        - VERIFIED
        - REJECTED
  securitySchemes:
    Api-Access-Key:
      type: apiKey
      name: Api-Access-Key
      in: header
      description: An API key associated with a security role

````

## Related topics

- [Get customer onboarding application by ID](https://docs.anchorage.com/knowledge-base/api-reference/v2-platforms/onboarding/get-customer-onboarding-application-by-id.md)
- [List customers](https://docs.anchorage.com/knowledge-base/api-reference/v4/customers/list-customers.md)
- [Create customers](https://docs.anchorage.com/knowledge-base/api-reference/v4/customers/create-customers.md)
- [List customer onboarding applications](https://docs.anchorage.com/knowledge-base/api-reference/v2-platforms/onboarding/list-customer-onboarding-applications.md)
- [Retrieve uploaded data and status of customer onboarding](https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/onboarding/retrieve-uploaded-data-and-status-of-customer-onboarding.md)
