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

# Get a 15-minute token for the borrower's in-app platform income verification

> Allowed at prequalified or additional_income, when the active offer lists platforms and
additional income is enabled. Moves the application to additional_income. The token is
returned once, here; it is not stored by Cr3dentials. Each call makes a new verification.




## OpenAPI

````yaml /api-reference/lending-openapi.yaml post /v1/applications/{id}/income-verification
openapi: 3.1.0
info:
  title: Cr3dentials Lending API
  version: 1.0.0
  description: >
    The partner API for Cr3dentials lending: applications, money steps,
    repayments and credit profiles. Money is integer USD cents.

    Every POST takes an Idempotency-Key header. Repeating a request with the
    same key and body

    replays the first response. Reusing a key with a different request is a 409.


    Webhooks (see `webhooks`): Cr3dentials POSTs outcomes that happen after a
    response to the partner's

    webhook URL as JSON `{event_id, type, created_at, data}`.

    - Signature: `X-Timestamp` is unix seconds; `X-Signature` is `v1=<lowercase
    hex HMAC-SHA256(secret, "<X-Timestamp>." + raw body)>`.
      The key is the whole `whsec_...` secret string. Verify against the raw body bytes before parsing.
    - The signing secret is shared once, when your webhook URL is registered.
    Rotating it ends the old
      secret at once.
    - Delivery is at least once: deduplicate by `event_id`. Answer 2xx to
    acknowledge. 408, 429, 5xx and
      network errors are retried with backoff for about 3 hours; any other 4xx stops delivery of that event.
    - Order is not guaranteed. `GET /v1/applications/{id}` is the source of
    truth.
servers: []
security:
  - bearerAuth: []
paths:
  /v1/applications/{id}/income-verification:
    post:
      summary: >-
        Get a 15-minute token for the borrower's in-app platform income
        verification
      description: >
        Allowed at prequalified or additional_income, when the active offer
        lists platforms and

        additional income is enabled. Moves the application to
        additional_income. The token is

        returned once, here; it is not stored by Cr3dentials. Each call makes a
        new verification.
      operationId: startIncomeVerification
      parameters:
        - $ref: '#/components/parameters/ApplicationId'
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '201':
          description: The verification token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomeVerificationStart'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: INVALID_STATE, or an idempotency conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            INCOME_VERIFICATION_UNAVAILABLE. The token could not be issued; try
            again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    ApplicationId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: 1 to 255 visible ASCII characters
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    IncomeVerificationStart:
      type: object
      required:
        - verification_id
        - token
        - expires_at
        - platforms
      properties:
        verification_id:
          type: string
          format: uuid
        token:
          type: string
          description: >-
            Single-use, valid until expires_at. Pass it to the in-app
            verification.
        expires_at:
          type: string
          format: date-time
        platforms:
          type: array
          items:
            type: string
    Error:
      type: object
      required:
        - error
        - request_id
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items: {}
        request_id:
          type: string
  responses:
    Unauthenticated:
      description: UNAUTHENTICATED
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: NOT_FOUND, also for another partner's application
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Token from POST /v1/oauth/token (client credentials)

````

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