Skip to main content
GET
Get an onboarding
v2 · Base URL https://api.fintoc.com/v2

Authorizations

Authorization
string
header
required

Path Parameters

entity_id
string
required

The unique identifier of the entity (for example ent_8anBwgZktbZH6ydyHa6Tm0eM).

id
string
required

The unique identifier of the onboarding (for example onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K).

Response

Returns the onboarding object with its current status, reviewed data, declared legal representatives and shareholders, and the status of every required document slot.

id
string
required

Unique identifier of the onboarding.

Example:

"onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K"

object
any
required

Type of the object. Always onboarding.

data
object
required

Reviewed data for the onboarding, grouped by type. Onboardings created through the API include company_information and transactional_profile. Fintoc sets declaration_accepted to true on creation and returns incorporation_date as an ISO 8601 datetime in UTC.

Example:
documents
object[]
required

Document slots for the onboarding, with their upload status.

entity_id
string | null
required

Identifier of the entity this onboarding belongs to. null if not associated with an entity.

Example:

"ent_8anBwgZktbZH6ydyHa6Tm0eM"

Legal representatives declared for the entity.

reviewed_at
string<date-time> | null
required

ISO 8601 datetime, in UTC, of when the onboarding was reviewed. null until it is reviewed.

Example:

"2026-01-16T09:00:00Z"

shareholders
object[]
required

Shareholders declared for the entity.

source
enum<string>
required

Channel the onboarding is being completed through. One of api or dashboard.

Available options:
api,
dashboard
Example:

"api"

status
enum<string>
required

Current status of the onboarding. One of pending, in_progress, submitted, approved, rejected or cancelled.

Available options:
pending,
in_progress,
submitted,
approved,
rejected,
cancelled
Example:

"pending"

submittable
boolean
required

Whether the onboarding has every required field and document completed and can be submitted for review.

Example:

false

submitted_at
string<date-time> | null
required

ISO 8601 datetime, in UTC, of when the onboarding was submitted for review. null until it is submitted.

Example:

"2026-01-15T14:30:00Z"