Create

The partner route is responsible for creating a customer PJ representative.

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 PJ customer code as a parameter.

Partner Types

ValueDescription
1Attorney
2Partner
3Administrator

Response

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

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 partner created in the request

Request Parameters

Path Params
string
required

PJ Customer Code

Body Params
string
required
Defaults to 12345678910

Document CPF

string
required
Defaults to Teste da Silva

Name

int32
required
Defaults to 1

Partner Type

string
required
Defaults to 11912345678

Telephone Number

string
required
Defaults to [email protected]

Email

address
object
required

Address

Responses

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