Update

The update route is responsible for modifying the information of an existing Legal Entity (PF) client.

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

🚧

Attention point:

  • To consume the route it is necessary to pass the client code as a parameter.

Identification Types

ValueDescription
1RG
2CNH

Civil Status Types

ValueDescription
1Single
2Married
3Divorced
4Widower

Type of education

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

Types of Scholarity

CodeDescription
1Incomplete Elementary Education
2Complete Elementary Education
3Incomplete Secondary Education
4Complete Secondary Education
5Technical Education
6Technologist
7Incomplete Higher Education
8Complete Higher Education
9Post-Graduate
10Master's Degree
11Doctorate

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 success of the request

Request Parameters

Path Params
string
required

Client Code

Body Params
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

string
required
Defaults to Brasileiro

Client nationality type

string
required
Defaults to MG

Client nationality state

int32
required
Defaults to 1

Client scholarity

string
required
Defaults to Cientista de Dados

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