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

# Onboarding object

> >-

An `Onboarding` holds the Know Your Customer review of an `Entity`: company information, legal representative, transactional profile, shareholders, and documents. You create one onboarding per `Entity`, complete each step and document, and submit the onboarding for Fintoc to review.

The `Onboarding` object has these attributes:

| Field          | Type    | Description                                                                                                             |
| :------------- | :------ | :---------------------------------------------------------------------------------------------------------------------- |
| `id`           | string  | Unique identifier of the onboarding.                                                                                    |
| `object`       | string  | The type of the object, which is always `onboarding`.                                                                   |
| `data`         | object  | Reviewed data for each completed step, keyed by step key.                                                               |
| `documents`    | array   | Document slots across every step, with their upload status. See the `OnboardingDocument` object.                        |
| `entity_id`    | string  | Identifier of the `Entity` this onboarding belongs to. `null` if the onboarding is not associated with an `Entity`.     |
| `reviewed_at`  | string  | ISO 8601 datetime in UTC when Fintoc reviewed the onboarding. `null` until Fintoc reviews the onboarding.               |
| `shareholders` | array   | Shareholders declared for the `Entity`. See the `OnboardingShareholder` object.                                         |
| `source`       | string  | Completion channel for the onboarding. One of `api` or `dashboard`.                                                     |
| `status`       | string  | Current status of the onboarding. One of `pending`, `in_progress`, `submitted`, `approved`, `rejected`, or `cancelled`. |
| `submittable`  | boolean | Whether the onboarding has every required step and document completed.                                                  |
| `submitted_at` | string  | ISO 8601 datetime in UTC when you submitted the onboarding for review. `null` until you submit the onboarding.          |

## Onboarding Shareholder object

The `OnboardingShareholder` object has these attributes:

| Field        | Type   | Description                                                                            |
| :----------- | :----- | :------------------------------------------------------------------------------------- |
| `id`         | string | Unique identifier of the shareholder.                                                  |
| `object`     | string | The type of the object, which is always `onboarding_shareholder`.                      |
| `document`   | object | Identification document slot for the shareholder. See the `OnboardingDocument` object. |
| `holder_id`  | string | Mexican tax ID (RFC) of the shareholder. `null` if not provided.                       |
| `last_name`  | string | Last name. Only present when `type` is `natural_person`.                               |
| `name`       | string | Given name of a natural person, or business name of a legal entity.                    |
| `parent_id`  | string | Identifier of the parent shareholder when nested. `null` for root shareholders.        |
| `percentage` | number | Participation percentage held by the shareholder, from `0` to `100`.                   |
| `type`       | string | Type of shareholder. One of `natural_person` or `legal_entity`.                        |

## Onboarding Document object

The `OnboardingDocument` object has these attributes:

| Field         | Type   | Description                                                                                        |
| :------------ | :----- | :------------------------------------------------------------------------------------------------- |
| `filename`    | string | Original filename of the uploaded document. Only present when `status` is `uploaded`.              |
| `slot_key`    | string | Key identifying the document slot.                                                                 |
| `status`      | string | Document slot status. One of `uploaded` or `missing`.                                              |
| `uploaded_at` | string | ISO 8601 datetime in UTC when you uploaded the document. Only present when `status` is `uploaded`. |

```json Onboarding object theme={null}
{
  "id": "onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K",
  "object": "onboarding",
  "data": {
    "company_information": {
      "legal_name": "Test Company 1"
    }
  },
  "documents": [
    {
      "filename": "csf.pdf",
      "slot_key": "tax_registration_certificate",
      "status": "uploaded",
      "uploaded_at": "2026-01-15T14:30:00Z"
    }
  ],
  "entity_id": "ent_8anBwgZktbZH6ydyHa6Tm0eM",
  "reviewed_at": null,
  "shareholders": [
    {
      "id": "onbsh_0ujsswThIGTUYm2K8FjOOfXtY1K",
      "object": "onboarding_shareholder",
      "document": {
        "filename": "ine.pdf",
        "slot_key": "identification",
        "status": "uploaded",
        "uploaded_at": "2026-01-15T14:30:00Z"
      },
      "holder_id": "AAAA010101AAA",
      "last_name": "Customer",
      "name": "Test Customer 1",
      "parent_id": null,
      "percentage": 76,
      "type": "natural_person"
    }
  ],
  "source": "api",
  "status": "in_progress",
  "submittable": false,
  "submitted_at": null
}
```