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

# Post-Offer KYC

> Complete the post-offer KYC gate. Final step before loan disbursement.

## Overview

Completes the post-offer KYC gate and triggers the disbursement eligibility check. All of the following must be true before this call succeeds:

* Customer has agreed to terms of use (`POST /terms/agree`)
* Offer has been accepted (`POST /offer/accept`)
* Board resolution uploaded (non-sole-proprietor businesses only)
* Board resolution admin review is not `FAILED`
* Guarantor form admin review is not `FAILED` (if a guarantor was added)

On success, the `offerStatus` transitions to `POST_OFFER_KYC` and the disbursement eligibility check fires automatically.

### Request

**Method:** `POST`\
**URL:** `/v1/loans/:applicationId/post-offer-kyc`

#### Parameters

| Name            | In     | Type     | Required | Description                 |
| --------------- | ------ | -------- | -------- | --------------------------- |
| `x-carbon-key`  | Header | `string` | Yes      | API key for authentication. |
| `applicationId` | Path   | `string` | Yes      | Application ID.             |

No request body required.

### Response

#### 200 OK

```json theme={null}
{
  "status": "success",
  "message": "Post-offer KYC saved",
  "data": {}
}
```

#### Error Responses

| Status | Message                                                                      | Cause                                        |
| ------ | ---------------------------------------------------------------------------- | -------------------------------------------- |
| 400    | `Application not found`                                                      | Invalid `applicationId`                      |
| 422    | `Application has no loan ID`                                                 | Application not yet registered               |
| 400    | `Please agree to terms of use before proceeding`                             | `POST /terms/agree` not yet called           |
| 400    | `Please accept your loan offer before proceeding`                            | `POST /offer/accept` not yet called          |
| 400    | `Please upload your board resolution document before proceeding`             | Non-sole-proprietor missing board resolution |
| 400    | `Please address the admin review feedback on your board resolution document` | Board resolution admin review failed         |
| 400    | `Please address the admin review feedback on your guarantor document`        | Guarantor form admin review failed           |


## OpenAPI

````yaml POST /v1/loans/{applicationId}/post-offer-kyc
openapi: 3.0.0
info:
  title: Carbon Business API
  description: >-
    ## Welcome to our API Developer Documentation


    Carbon aims to unlock the full potential of your business with a
    feature-rich account designed for growth.


    ## Integrations


    We aim to provide our APIs for developers and businesses to offer financial
    services to their existing customer base through REST APIs without doing the
    heavy lifting. Our API has predictable resource-oriented URLs, accepts
    form-encoded request bodies, returns JSON-encoded responses, and uses
    standard HTTP response codes, authentication, and verbs.


    ### Authentication


    `Authorization : API Key`


    Header  

    `x-carbon-key : value`


    `x-carbon-key` can be generated via developer page on Carbon Business


    | Environment | URL |

    | --- | --- |

    | Live |  |

    | Sandbox |
    [https://carbonapistagingsecure.getcarbon.co/baas/api](https://carbonapistagingsecure.getcarbon.co/baas/api)
    |


    ### **Handling Errors**


    We use the conventional HTTP response codes to indicate the success or
    failure of an API request.  

    Codes in the 2xx range indicate success. Codes in the 4xx range indicate an
    error that failed given the information provided (e.g., a required parameter
    was omitted, etc.). Codes in the 5xx range indicate an error with our
    servers.


    | Error | Description |

    | --- | --- |

    | 400 - Bad Request | The request was unacceptable, often due to missing a
    required parameter. |

    | 401 - Unauthorized | Not a valid API key was provided. |

    | 402 - Request Failed | The parameters were valid but the request failed. |

    | 403 - Forbidden | The API key doesn't have permission to perform the
    request. |

    | 404 - Not Found | The requested resource doesn't exist. |

    | 429 - Too Many Requests | Too many requests hit the API |

    | 500, 502, 503, 504 - Server Errors | System Error |
  version: 1.0.0
servers:
  - url: https://carbonapistagingsecure.getcarbon.co/baas/api
    description: >-
      Replace {{base_url}} with your API base URL (e.g.,
      https://api.example.com)
security:
  - apikeyAuth: []
tags:
  - name: Accounts
    description: >-
      Virtual accounts are generated account details (account number and bank)
      that allow Carbon Business merchants to receive payments from customers
      via NGN bank transfer. This is currently only available in naira (NGN).


      Virtual accounts are either dynamic (temporary) or static (permanent). A
      dynamic account number expires after handling a transaction, while a
      static account number doesn't expire.


      **Static Account**


      Creating static accounts can be useful when receiving recurring payments
      through bank transfers. The process involves generating a static virtual
      account with customer information. Once payment is made, we will send you
      a webhook notification, which you can then manage.


      **Dynamic Account**


      Creating dynamic accounts can be useful when receiving one-time payments
      through bank transfers. The process involves generating a dynamic virtual
      account with a set amount for the customer during checkout. Once payment
      is made, we will send you a webhook notification, which you can then
      manage.


      Key things you can do with these endpoints:


      - Create an account

      - Retreive an account

      - Verify Transaction

      - Retreive a list of transactions
  - name: Accounts > Transactions
  - name: Banks
    description: |-
      - Get a list of banks and financial institutions
      - Verify/resolve account details
  - name: Customers
    description: >-
      This collection contains a set of API endpoints to manage customer-related
      operations for an application. The endpoints allow for creating a new
      customer, retrieving a list of all customers, and fetching details of a
      single customer.


      - Create Customer
          
      - Fetch Customer/Customers
  - name: Payout
    description: |-
      - Make Transfer
      - Verify Transfer
  - name: Status
    description: '- Service Health check'
  - name: Verification
  - name: Webhook
    description: |-
      ## EVENTS

      `account.incoming-transaction`

      ``` json
      {
          "event": "account.incoming-transaction",
          "data": {
              "id": "string",
              "amount": "float",
              "currency": "string",
              "transactionType": "string",
              "entryDate": "datetime",
              "uniqueRef": "string",
              "account": {
                  "id": "string",
                  "bankAccount": {
                      "accountName": "string",
                      "accountNumber": "string",
                      "bank": {
                          "code": "string",
                          "name": "string"
                      }
                  },
                  "static": boolean,
                  "currency": "string",
                  "clientId": "string"
              }
            }
      }

       ```

      `account.outgoing-transaction`

      ``` json
      {
          "event": "account.outgoing-transaction",
          "data": {
              "id": "string",
              "amount": "float",
              "currency": "string",
              "transactionType": "string",
              "entryDate": "datetime",
              "uniqueRef": "string",
              "account": {
                  "id": "string",
                  "bankAccount": {
                      "accountName": "string",
                      "accountNumber": "string",
                      "bank": {
                          "code": "string",
                          "name": "string"
                      }
                  },
                  "static": boolean,
                  "currency": "string",
                  "clientId": "string"
              }
          }
      }

       ```
  - name: Loans
    description: >-
      Partner lending API. Enables fintech partners to originate business loans
      for their end-customers.


      - Enroll customers for lending and trigger KYC

      - Submit loan applications and supporting documents

      - Manage offer acceptance, disbursement account, and post-offer steps

      - Charge repayments and retrieve repayment schedules
paths:
  /v1/loans/{applicationId}/post-offer-kyc:
    post:
      tags:
        - Loans
      summary: Post-Offer KYC
      description: >-
        Triggers post-offer KYC verification. Prerequisites — offer accepted,
        terms agreed, board resolution submitted (non-sole-prop businesses), and
        no failed admin reviews.

        ### Request Body

        No body required.

        ### Response

        - `status` (string): success - `message` (string): Post-offer KYC
        initiated
      parameters:
        - name: x-carbon-key
          in: header
          schema:
            type: string
          required: true
          example: '{{access_token}}'
        - name: applicationId
          in: path
          schema:
            type: string
          required: true
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
              example:
                status: success
                message: Post-offer KYC initiated
components:
  securitySchemes:
    apikeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Provide your API key in the 'apikey' header.

````