Register a new person/customer

post

https://api-bnpl-wl.sandbox.open-co.tech/person

Registers a new customer or updates an existing one. Required before creating an application for partners whose customers are not pre-registered in the KYC provider.

The authenticated partner's source_kyc configuration determines the KYC provider:

qitech — data is forwarded to QI Tech CaaS for analysis; kyc_status in the response reflects the analysis result.
openco (default) — registered locally only.

Re-registration (liveness revalidation): If the document_number already exists but the request carries a different person_id (from a new liveness validation), the system:

Maps the new external person_id to the existing internal identifier.
Stores a snapshot of the full registration payload for audit.
Updates the person's data with the incoming values.
Returns HTTP 200 with the existing internal person_id.

A single person can accumulate multiple external person_id mappings over time (one per liveness session).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

person_id

string

External person identifier from the partner's liveness/KYC session. Required for partners with source_kyc: qitech; optional for openco. When provided for an existing document_number, the system maps this new external ID to the existing internal identifier and stores a snapshot of the registration payload.

name

string

required

Customer's full name

document_number

string

required

Customer's CPF. Accepts formatted (e.g., 111.111.111-11) or unformatted (e.g., 11111111111). Non-numeric characters are stripped internally before storage.

emails

array of objects

required

Customer's email addresses

emails*

phones

array of objects

required

Customer's phone numbers

phones*

address

object

required

birthdate

date

required

Customer's date of birth (YYYY-MM-DD)

gender

string

enum

Customer's gender

Show Details

male	Male
female	Female
other	Other / Non-binary

Allowed:

nationality

string

Country code (ISO 3166-1 alpha-3)

monthly_income

integer

Monthly income in cents (BRL)

occupation

string

Customer's occupation

mother_name

string

Mother's full name

father_name

string

Father's full name

face_recognition_id

uuid

Face recognition ID from the partner's biometric capture SDK. Optional convenience field — when provided, it is mapped internally to face.registration_key. Only used by partners that perform liveness validation before registration.

session_id

uuid

Session identifier from the partner's anti-fraud SDK. Optional convenience field — when provided, it is mapped internally to source.session_id. Used for onboarding traceability.

ip_address

string

IP address of the device used during registration. Optional — stored for fraud analysis and audit purposes.

device_fingerprint

string

Device fingerprint token from the partner's device intelligence SDK. Optional — stored for fraud analysis and audit purposes.

Responses

200Person registered or updated successfully. For partners with source_kyc=openco, returns the internal person_id. For partners with source_kyc=qitech, returns the external person_id provided in the request (the same identifier the partner used during registration).

400Invalid request parameters