Saltar al contenido principal
GET
Get an onboarding
v2 · Base URL https://api.fintoc.com/v2

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

entity_id
string
requerido

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

id
string
requerido

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

Respuesta

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
requerido

Unique identifier of the onboarding.

Ejemplo:

"onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K"

object
any
requerido

Type of the object. Always onboarding.

data
object
requerido

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.

Ejemplo:
documents
object[]
requerido

Document slots for the onboarding, with their upload status.

entity_id
string | null
requerido

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

Ejemplo:

"ent_8anBwgZktbZH6ydyHa6Tm0eM"

Legal representatives declared for the entity.

reviewed_at
string<date-time> | null
requerido

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

Ejemplo:

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

shareholders
object[]
requerido

Shareholders declared for the entity.

source
enum<string>
requerido

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

Opciones disponibles:
api,
dashboard
Ejemplo:

"api"

status
enum<string>
requerido

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

Opciones disponibles:
pending,
in_progress,
submitted,
approved,
rejected,
cancelled
Ejemplo:

"pending"

submittable
boolean
requerido

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

Ejemplo:

false

submitted_at
string<date-time> | null
requerido

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

Ejemplo:

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