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

# Fetch KYC Configuration

> Returns the KYC configuration and field requirements for a customer.

<Prompt description="Fetch KYC Configuration" actions={["cursor"]}>
  Integrate the DollarPe Fetch KYC Configuration endpoint into my application.

  Endpoint: GET /kyc/configuration/{customer_id}
  Base URL: [https://api.dollarpe.in](https://api.dollarpe.in) (production) | [https://sandbox.dollarpe.in](https://sandbox.dollarpe.in) (sandbox)

  Auth headers required on every request:

  * X-API-KEY: your API key
  * X-TIMESTAMP: current Unix time in seconds
  * X-SIGNATURE: Base64(HMAC-SHA256(X-API-KEY + X-TIMESTAMP + sortedJSONBody, apiSecret))

  Task: Write a typed function that:

  1. Accepts a customer\_id string
  2. Builds the auth headers
  3. Calls GET /kyc/configuration/{customer_id}
  4. Returns the KYC configuration object (required fields, supported document types)
  5. Handles 400 (customer not found / access denied) and 500 errors

  Language: TypeScript
</Prompt>

| API Status Code | Response                            | Reason                                       |
| --------------- | ----------------------------------- | -------------------------------------------- |
| 400             | Customer not found or access denied | Customer not found                           |
| 400             | Customer not found or access denied | Customer does not belong to the organization |
| 500             | Internal Server Error.              | Internal Server Error                        |


## OpenAPI

````yaml GET /kyc/configuration/{customer_id}
openapi: 3.1.0
info:
  title: DollarPe API
  description: API for DollarPe - Customer, Payout, and Webhook services
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox.dollarpe.xyz/pos/api/v1
    description: Payout API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
  - url: https://sandbox.dollarpe.xyz/cms/api/v1
    description: Customer API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
security:
  - ApiKeyAuth: []
    TimestampAuth: []
    SignatureAuth: []
tags:
  - name: Customer
    description: Customer related operations
    x-displayName: Customer
    x-traitTag: true
  - name: Payout
    description: Payout related operations
  - name: Webhooks
    description: Webhook related operations
  - name: Widget
    description: Hosted buy/sell widget session initialization
paths:
  /kyc/configuration/{customer_id}:
    get:
      tags:
        - KYC
      description: >-
        Returns basic configuration for KYC - supported document types,
        additional information fields required
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    type: object
                    properties:
                      supported_document_types:
                        type: array
                        example:
                          - AADHAAR
                          - PASSPORT
                          - VOTER_ID
                          - DRIVING_LICENSE
                      additional_info_required:
                        type: object
                        properties:
                          options:
                            type: array
                            example:
                              - income_range
                              - profession
                          rules:
                            type: object
                            example:
                              type: allOf
                              min_required: 2
                          income_range:
                            type: object
                            example:
                              type: string
                              required: true
                          profession:
                            type: object
                            example:
                              type: string
                              required: true
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
                  data:
                    type: 'null'
                  err_code:
                    type: string
                    example: SYS_INTERNAL_ERROR
                  errors:
                    type: string
                    example: Unexpected error occurred. Please try again later.
      servers:
        - url: https://sandbox.dollarpe.xyz/cms/api/v1
          description: KYC API Base URL
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key for authentication
    TimestampAuth:
      type: apiKey
      in: header
      name: X-TIMESTAMP
      description: Current timestamp in seconds since epoch
    SignatureAuth:
      type: apiKey
      in: header
      name: X-SIGNATURE
      description: HMAC SHA256 signature of the request encoded in Base64

````