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

# Download an eID report

> Required scope: `kyc:eid`.

the eID provider's PDF report of a completed check, for the client's file.

Guide: [eID check](/guides/eid).



## OpenAPI

````yaml /openapi.json get /v1/kyc/eid/{key}/report
openapi: 3.1.0
info:
  title: Sahl Partner API
  version: 0.2.0
  description: >-
    Server-to-server API for lenders and banks: document reading, verification,
    risk assessment and eID checks. Authenticate with `Authorization: Bearer
    <API key>`. Paths are relative to the server URL. New workspaces start in
    sandbox.
servers:
  - url: https://app.sahlfinancial.com/api
    description: Single API host. Send environment=sandbox (the default) for test data.
security:
  - bearerAuth: []
tags:
  - name: KYC
    description: Read documents, verify a profile, assess risk, start an eID check.
  - name: Bank connections (Growth)
    description: >-
      Growth plan, switched on per workspace by Sahl. Sandbox simulation today;
      production answers 409 until a bank data provider is live.
paths:
  /v1/kyc/eid/{key}/report:
    get:
      tags:
        - KYC
      summary: Download an eID report
      description: >-
        Required scope: `kyc:eid`.


        the eID provider's PDF report of a completed check, for the client's
        file.


        Guide: [eID check](/guides/eid).
      operationId: eid_report
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: integer
            title: Key
          description: The `key` returned by `POST /v1/kyc/eid`.
          example: 123456
      responses:
        '200':
          description: >-
            The PDF report (`Content-Disposition: attachment;
            filename="eid-<key>.pdf"`).
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '401':
          description: Missing, invalid, revoked or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail: Invalid or revoked API key
        '403':
          description: >-
            Key lacks the scope, or the workspace is not enabled for the partner
            KYC API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: kyc_scope_not_allowed
                  message: This workspace is not enabled for the partner KYC API.
        '404':
          description: >-
            Unknown key, a key of another workspace, or no eID provider account
            (`identity verification is not set up for this tenant`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            Per-IP rate limit: 100 requests a minute on these routes. Carries
            `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFlat'
              example:
                code: rate_limit_exceeded
                message: Too many requests. Please slow down.
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFlat'
              example:
                code: internal_error
                message: An unexpected error occurred
                details: null
        '502':
          description: The eID provider did not answer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail: the identity verification service did not answer
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      title: Error
      description: >-
        FastAPI error body. `detail` is a string, or an object with `code` and
        `message` (extra keys possible).
      properties:
        detail:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
              properties:
                code:
                  type: string
                message:
                  type: string
      required:
        - detail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorFlat:
      type: object
      title: ErrorFlat
      description: >-
        Body of a rate-limit 429, an unknown route 404 and a 500: `code` and
        `message` at the top level, with no `detail`.
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type:
            - string
            - 'null'
          description: Present on a 500 only; null unless the server runs in debug mode.
      required:
        - code
        - message
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in the console. Scopes: kyc:extract, kyc:verify,
        kyc:eid; bank:read, bank:write (Growth plan, enabled per workspace by
        Sahl).

````

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