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

# Get enrolment

> The customer's enrolment and its status.



## OpenAPI

````yaml api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/enrollment
openapi: 3.1.0
info:
  title: Endl Cards API
  version: '0'
  description: >-
    Issue virtual cards to your customers: enrol the customer, fund the card
    balance, issue cards, show card details securely, and follow every
    transaction by webhook.


    Paths are under `/api/v0`. The key must carry the **`cards`** permission.
    **This API is not final yet** — see [what may still
    change](/api-reference/cards/introduction#not-final-yet).
servers:
  - url: https://api-sandbox.endl.io
    description: Sandbox
security:
  - apiKey: []
tags:
  - name: Enrolment
  - name: Cardholders
  - name: Cards
  - name: Card details
  - name: Transactions and balance
  - name: Deposits
  - name: Withdrawals
paths:
  /api/v0/cards/{customerId}/enrollment:
    get:
      tags:
        - Enrolment
      summary: Get enrolment
      description: The customer's enrolment and its status.
      parameters:
        - $ref: '#/components/parameters/ApiVersion'
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: The enrolment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Enrolment'
              example:
                customerId: cus_1Xb7...
                status: pending
                reason: null
                updatedAt: '2026-10-16T08:30:02Z'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The API key lacks the `cards` permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Customer not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    ApiVersion:
      name: Api-Version
      in: header
      required: true
      description: >-
        The API version this request targets. `2026-09.1`. See
        [Versioning](/api-reference/versioning).
      schema:
        type: string
        pattern: ^\d{4}-\d{2}\.\d+$
        default: 2026-09.1
      example: 2026-09.1
    CustomerId:
      name: customerId
      in: path
      required: true
      description: An individual, a business or an employee (`cus_`).
      schema:
        type: string
        example: cus_1Xb7...
  schemas:
    Enrolment:
      type: object
      properties:
        customerId:
          type: string
          example: cus_1Xb7...
        status:
          type: string
          enum:
            - pending
            - active
            - rejected
            - locked
            - canceled
          description: >-
            `pending` — under review; businesses are reviewed by our team first,
            so they take longer, and if more information is needed `reason` says
            so. `active` — enrolled; cards can be issued. `rejected` — not
            approved; `reason` says why. `locked` — temporarily blocked; contact
            Endl support. `canceled` — closed.
        reason:
          oneOf:
            - $ref: '#/components/schemas/Reason'
            - type: 'null'
          description: '`{ code, message }` when set, otherwise `null`.'
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      description: >-
        The standard Endl error body. `errors[].code` is an `ERRCRD_` code —
        **the code numbers are not final yet** — and `field` names the request
        field when one is at fault.
      properties:
        code:
          type: integer
        message:
          type: string
        status:
          type: string
          enum:
            - ERROR
        data:
          type: 'null'
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              field:
                type:
                  - string
                  - 'null'
    Reason:
      type: object
      description: '`{ code, message }`. The enrolment `reason` codes are **not final yet**.'
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Api-Key
      description: Partner API key. Must carry the `cards` permission.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.