API docs by Redocly

RIOPAG Face KYC (1.0)

Download OpenAPI specification :Download

Misc

Create New User

Authorizations:
{{API_KEY}}
Request Body schema: application/json
required
cpf
required
string
webhook_url
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json; charset=utf-8
{
  • "guid": "03b47d9c-61b9-4b77-b7a4-1c55bd437ac5"
}

Get User info

header Parameters
Authorization
required
string
Example: {{API_KEY}}

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 15,
  • "guid": "03b47d9c-61b9-4b77-b7a4-1c55bd437ac5",
  • "name": "MARCELO AUGUSTO PEREIRA",
  • "email": null,
  • "role": "user",
  • "gender": "M",
  • "birth_date": "1975-07-12",
  • "tax_id_status": "REGULAR",
  • "front_url": "kyc/03b47d9c-61b9-4b77-b7a4-1c55bd437ac5/front/20250117175010_33bdd830-a782-4bc8-9999-867a571f0be6",
  • "back_url": null,
  • "selfie_url": null,
  • "has_obit_indication": false,
  • "birth_country": "BRASILEIRA",
  • "cpf": "18219822821",
  • "lat": null,
  • "lng": null,
  • "status": "pending",
  • "reason": null,
  • "allow_submission": true,
  • "last_submission_at": null,
  • "webhook_url": "https://example.com/webhook",
  • "ip_address": null,
  • "created_at": "2025-01-17T23:17:41.290Z"
}

Upload User File

header Parameters
Authorization
required
string
Example: {{USER_GUID}}
Request Body schema: multipart/form-data
optional
type
required
string
file
required
string <binary>

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "url": "kyc/03b47d9c-61b9-4b77-b7a4-1c55bd437ac5/front/20250117175010_33bdd830-a782-4bc8-9999-867a571f0be6"
}

Submit User Document

header Parameters
Authorization
required
string
Example: {{USER_GUID}}
Request Body schema: application/json
required
lat
required
number
lng
required
number

Responses

Request samples

Content type
application/json
{
  • "lat": -23.55052,
  • "lng": -46.633308
}

Response samples

Content type
application/json; charset=utf-8
{
  • "matches": true,
  • "similarity": 0.7907907962799072,
  • "status": "approved",
  • "reason": "",
  • "frontImageSize": 1654093,
  • "selfieImageSize": 957899
}