Endpoint that returns the data of the User logged into the API, including important information such as the User ID, Company ID, etc.

Legitimuz

Get Started

OCR + Facematch validation is a solution that allows for the validation of identification documents and the comparison of the document photo with the user photo.

Introduction

Installation

Options

Methods

The fields below are automatically filled by the Legitimuz SDK based on the CPF provided in the cpf field.

Field List

Action List

Introduction to the Geolocation Monitoring SDK

Actions List

Endpoint responsible for performing API authentication.
Required data: **Username and Password**.
After authentication, a Token (Bearer Token) will be generated, which must be informed in other Endpoints to continue with the Validation Proposal Creation process.

Login

Get SDK

Conducts a CPF query for enriching client information, retrieving various data about the individual.

Get CPF

Endpoint that performs the query of all released and active Legitimuz keys, each integration key provides access to Legitimuz KYC products.

List

Endpoint responsible for the Deletion of Legitimuz API integration keys.

Delete

Creation of a new integration key requires specifying the domain (URL / Site) that will manage the key. Access is granted only through the specific domain, along with the Label / Name of the key for easy recognition and identification by users.

Create

This endpoint allows you to create a new transaction with specified details.

This endpoint allows you to update the status of a specific transaction identified by its ID.

Update

This endpoint allows you to send an SMS message. It requires a Bearer Token (JWT) for authentication, which can be generated using the endpoint "/external/generate_jwt".
The response format is outlined below.
Additionally, you'll need to include the API key in the request header, which can be obtained by making a POST request to the IntegrationTokens endpoint.

Send message

This endpoint allows you to send a validation code via SMS to a specified phone number. It requires a Bearer Token (JWT) for authentication, which can be generated using the endpoint "/external/generate_jwt".
The response format is outlined below.

Send code

This endpoint allows you to validate a code received via SMS on a specified phone number. It requires a Bearer Token (JWT) for authentication, which can be generated using the endpoint "/external/generate_jwt".
The response format is outlined below.

Validate code

Endpoint that performs the query of CPF data in the Federal Revenue database, mandatory fields: Legitimuz Token and Client's CPF.

Autentication

KYC

Integrations

Transactions

SMS

Receita Federal

Me

Headers

Body