Create

The create route is responsible for creating a new Legal Entity (PF) client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Identification Types

ValueDescription
1RG
2CNH

Civil Status Types

ValueDescription
1Single
2Married
3Divorced
4Widower

Types of Scholarity

CodeDescription
1Ensino Fundamental Incompleto
2Ensino Fundamental Completo
3Ensino Médio Incompleto
4Ensino Médio Completo
5Técnico
6Técnologo
7Ensino Superior Incompleto
8Ensino Superior Completo
9Pós-Graduação
10Mestrado
11Doutorado

Types of Occupation

ValueDescription
1Unemployed
2Retired
3Salaried
4Autonomous
5DO LAR
6Businessman
7Trainee
8Student
9Pensioner
10Rural Producer
11Not Declared

Response

Http CodeReturn CodeMessage
200200-01Success.
400400-01Something unexpected happened.
400400-10Please provide the correct document.
400400-11Error registering.
401401-05Unauthorized or token invalid.
406406-01User was not found.
406406-03field 'X' is mandatory and was not informed.
409409-01Customer already registered on the base.
429429-01Too many requests.

Response Parameters

ParameterFormatDescription
request_codestringCode of the request made.
returnbooleanIndicates if the request was successful.
return_codestringReturn code of the request.
messagestringMessage indicating the reason for the response.
dataobjectObject containing additional information.
data.codestringCode associated with the customer created in the request.

Request Parameters

Body Params
string
required
Defaults to 12345678910

Client CPF

string
required
Defaults to Client Name

Client name

date
required
Defaults to YYYY-MM-DD

Client birth date

int32
required
Defaults to 1

Client civil status

string

Client conj CPF

string

Client conj name

string
enum
required
Defaults to M

Client gender

Allowed:
string
required
Defaults to 11912345678

Client telephone

int32
required
Defaults to null

Client nationality type

string
required
Defaults to MG

Client nationality state

int32
required
Defaults to 1

Client scholarity

string
required
Defaults to Cientista da Computação

Client formacao

string
required
Defaults to [email protected]

Client email

string
required
Defaults to Mother Name

Client mother

identification
object
required

Client identification (RG/CNH)

address
object
required

Client address

company_works
object
required

Client company works

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json