Pular para o conteúdo principal
API docs by Redocly

Onboarding API

Download OpenAPI specification:Download

API for creating account onboarding in the ONZ platform.

This API allows account creation for:

  • Natural Person (NATURAL_PERSON)
  • Legal Person (LEGAL_PERSON)

Onboarding

Create new onboarding

Endpoint for creating account onboarding in the platform

Authorizations:
OAuth2
Request Body schema: application/json
required
One of
accountType
required
string
Value: "NATURAL_PERSON"
required
object (Person)

Responses

Response Schema: application/json
message
string
id
string <uuid>
status
integer

Request samples

Content type
application/json
Example
{
  • "accountType": "NATURAL_PERSON",
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Onboarding created successfully",
  • "id": "4fdd34d2-e9fa-4bb5-bfeb-84281f77f19a",
  • "status": 1
}

Upload onboarding images

This endpoint allows uploading identification documents and a selfie for a previously created onboarding process.

Accepted image types:

  • Front of the document (FRONT) – The front side of the identification document.
  • Back of the document (BACK) – The back side of the identification document.
  • Selfie (SELFIE) – A clear photo of the person's face.
Authorizations:
OAuth2
path Parameters
id
required
string <uuid>

Onboarding ID

Request Body schema: multipart/form-data
required
type
required
string
Enum: "FRONT" "BACK" "SELFIE"

Type of the image being uploaded

file
required
string <binary>

Image file (JPG or PNG, max 10MB)

Responses

Response Schema: application/json
required
object
type
required
string
Enum: "FRONT" "BACK" "SELFIE"
url
required
string <uri>

Signed URL to access the uploaded image

Request samples

Content type
multipart/form-data
Example
{
  "type": "FRONT",
  "file": "(binary)"
}

Response samples

Content type
application/json
Example
{}