Helpers & Monitoring
method required
Title: The HTTP Method of account change operation
Type: string
Example:
PATCH
uri required
Title: The URI of account change operation
Type: string
Example:
/v1/entities
/v1/accounts/{accountId}/customers/{customerId}
email required
Title: The email of operator that change accounts
Type: string
Example:
[email protected]
roles required
Type: array
origin required
Title: The request origin of account change operation
Type: string
Example:
APP
CRM
object required
Title: The object that represents the account changes requested
Type: objectnickname required
Title: The account entity nickname
Type: string or null
Example:
Nickprinted\_name required
Title: The account entity printed name
Type: string or null
Example:
Nickson Jr.social\_name required
Title: The account entity social name
Type: string or null
Example:
Nicksonaccount\_id required
Title: The account identifier
Type: integer
Example:
16665511document\_number required
Title: The account entity document number
Type: string or null
Example:
33126773000179type\_id required
Title: The account type identifier (person = 1, company = 2)
Type: integer
Example:
1
2entity\_type required
Title: The account entity type
Type: string
Example:
Company
Personname required
Title: The account entity name
Type: string or null
Example:
Nickson Jr.email required
Title: The account entity email
Type: string or null
Example:
[email protected]pep required
Title: Indicates if the account entity is PEP (Politically Exposed Person)
Type: boolean or null
Example:
true
falseregistration\_number
Title: The account entity registration number
Type: string or null
Example:
1company\_name
Title: The name of company thats represents account entity
Type: string or null
Example:
Companyactivity
Title: The activity of company thats represents account entity
Type: string or null
Example:
Dono da Companycompany\_type
Title: The type of company thats represents account entity
Type: string or null
Example:
MEI (Microempresário Individuai)company\_format
Title: The format of company thats represents account entity
Type: string or null
Example:
Ltda.
Me.
Co.company\_constitution\_date
Title: The constitution date of company thats represents account entity
Type: integer or null
Example:
2019-07-20annual\_revenues
Title: The annual revenues of company thats represents account entity
Type: number or null
Example:
0.05type
Title: The type of company thats represents account entity
Type: string or null
Example:
Businessnumber\_of\_partners
Title: The number partners of company thats represents account entity
Type: integer or null
Example:
5perc\_ownership
Title: The perc ownership of company thats represents account entity
Type: number or null
Example:
0.5fiscal\_situation
Title: The fiscal situation of company thats represents account entity
Type: string or null
Example:
Fiscalizadodebt
Title: The debt of company thats represents account entity
Type: number or null
Example:
0.5gender
Title: The gender of person thats represents account entity
Type: string or null
Example:
F
Mmarital\_status
Title: The marital status of person thats represents account entity
Type: string or null
Example:
MARRIED
SINGLEmothers\_name
Title: The mothers name of person thats represents account entity
Type: string or null
Example:
Josefabirth\_date
Title: The birth date of person thats represents account entity
Type: string or null
Example:
2019-01-01nationality
Title: The nationality of person thats represents account entity
Type: string or null
Example:
Brasilcity\_of\_birth
Title: The city of birth of person thats represents account entity
Type: string or null
Example:
São Paulostate\_of\_birth
Title: The state of birth of person thats represents account entity
Type: string or null
Example:
São Paulocountry\_of\_birth
Title: The country of birth of person thats represents account entity
Type: string or null
Example:
Brasildocument\_type
Title: The document type of person thats represents account entity
Type: string or null
Example:
RG
CNHother\_id\_number
Title: The other identifier number of person thats represents account entity
Type: number or null
Example:
123456document\_issued\_by
Title: When was issued the document of person representing the account entity
Type: string or null
Example:
SSP
ITEPdocument\_issued\_at
Title: Who issued document of person that's represents account entity
Type: string or null
Example:
RJdocument\_issued\_date
Title: The document issued date of person thats represents account entity
Type: integer or null
Example:
2019-07-19fathers\_name
Title: The fathers name of person thats represents account entity
Type: string or null
Example:
Joséassets
Title: The assets of person thats represents account entity
Type: number or null
Example:
0.01occupation required
Title: The occupation of company or person thats represents account entity
Type: string or null
Example:
Ocupadoincome required
Title: The income of company or person thats represents account entity
Type: number or null
Example:
0.05net\_worth required
Title: The net worth of company or person thats represents account entity
Type: number or null
Example:
0.05partners
Title: The company partner information. This is a metadata, so this object returns what we receive from the entity change request
Type: array or null
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Account entity updated",
"description": "This event occurs when an entity information changes. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/customerv1patch'>Update customer information</a> \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/accounts-overview#account-customers'>Customer objects</a>",
"required": [
"method",
"uri",
"email",
"roles",
"origin",
"object"
],
"properties": {
"method": {
"type": "string",
"title": "The HTTP Method of account change operation",
"examples": [
"PATCH"
]
},
"uri": {
"type": "string",
"title": "The URI of account change operation",
"examples": [
"/v1/entities",
"/v1/accounts/{accountId}/customers/{customerId}"
]
},
"email": {
"type": "string",
"title": "The email of operator that change accounts",
"examples": [
"[email protected]"
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"title": "The roles of operator that change accounts",
"examples": [
"test1",
"test2"
]
},
"origin": {
"type": "string",
"title": "The request origin of account change operation",
"examples": [
"APP",
"CRM"
]
},
"object": {
"type": "object",
"title": "The object that represents the account changes requested",
"required": [
"nickname",
"printed_name",
"social_name",
"account_id",
"document_number",
"type_id",
"entity_type",
"name",
"email",
"pep",
"occupation",
"income",
"net_worth"
],
"properties": {
"nickname": {
"type": [
"string",
"null"
],
"title": "The account entity nickname",
"examples": [
"Nick"
]
},
"printed_name": {
"type": [
"string",
"null"
],
"title": "The account entity printed name",
"examples": [
"Nickson Jr."
]
},
"social_name": {
"type": [
"string",
"null"
],
"title": "The account entity social name",
"examples": [
"Nickson"
]
},
"account_id": {
"type": "integer",
"title": "The account identifier",
"examples": [
16665511
]
},
"document_number": {
"type": [
"string",
"null"
],
"title": "The account entity document number",
"examples": [
"33126773000179"
]
},
"type_id": {
"type": "integer",
"title": "The account type identifier (person = 1, company = 2)",
"examples": [
1,
2
]
},
"entity_type": {
"type": "string",
"title": "The account entity type",
"examples": [
"Company",
"Person"
]
},
"name": {
"type": [
"string",
"null"
],
"title": "The account entity name",
"examples": [
"Nickson Jr."
]
},
"email": {
"type": [
"string",
"null"
],
"title": "The account entity email",
"examples": [
"[email protected]"
]
},
"pep": {
"type": [
"boolean",
"null"
],
"title": "Indicates if the account entity is PEP (Politically Exposed Person)",
"examples": [
true,
false
]
},
"registration_number": {
"type": [
"string",
"null"
],
"title": "The account entity registration number",
"examples": [
"1"
]
},
"company_name": {
"type": [
"string",
"null"
],
"title": "The name of company thats represents account entity",
"examples": [
"Company"
]
},
"activity": {
"type": [
"string",
"null"
],
"title": "The activity of company thats represents account entity",
"examples": [
"Dono da Company"
]
},
"company_type": {
"type": [
"string",
"null"
],
"title": "The type of company thats represents account entity",
"examples": [
"MEI (Microempres\u00e1rio Individuai)"
]
},
"company_format": {
"type": [
"string",
"null"
],
"title": "The format of company thats represents account entity",
"examples": [
"Ltda.",
"Me.",
"Co."
]
},
"company_constitution_date": {
"type": [
"integer",
"null"
],
"title": "The constitution date of company thats represents account entity",
"examples": [
"2019-07-20"
]
},
"annual_revenues": {
"type": [
"number",
"null"
],
"title": "The annual revenues of company thats represents account entity",
"examples": [
0.05
]
},
"type": {
"type": [
"string",
"null"
],
"title": "The type of company thats represents account entity",
"examples": [
"Business"
]
},
"number_of_partners": {
"type": [
"integer",
"null"
],
"title": "The number partners of company thats represents account entity",
"examples": [
5
]
},
"perc_ownership": {
"type": [
"number",
"null"
],
"title": "The perc ownership of company thats represents account entity",
"examples": [
0.5
]
},
"fiscal_situation": {
"type": [
"string",
"null"
],
"title": "The fiscal situation of company thats represents account entity",
"examples": [
"Fiscalizado"
]
},
"debt": {
"type": [
"number",
"null"
],
"title": "The debt of company thats represents account entity",
"examples": [
0.5
]
},
"gender": {
"type": [
"string",
"null"
],
"title": "The gender of person thats represents account entity",
"examples": [
"F",
"M"
]
},
"marital_status": {
"type": [
"string",
"null"
],
"title": "The marital status of person thats represents account entity",
"examples": [
"MARRIED",
"SINGLE"
]
},
"mothers_name": {
"type": [
"string",
"null"
],
"title": "The mothers name of person thats represents account entity",
"examples": [
"Josefa"
]
},
"birth_date": {
"type": [
"string",
"null"
],
"title": "The birth date of person thats represents account entity",
"examples": [
"2019-01-01"
]
},
"nationality": {
"type": [
"string",
"null"
],
"title": "The nationality of person thats represents account entity",
"examples": [
"Brasil"
]
},
"city_of_birth": {
"type": [
"string",
"null"
],
"title": "The city of birth of person thats represents account entity",
"examples": [
"S\u00e3o Paulo"
]
},
"state_of_birth": {
"type": [
"string",
"null"
],
"title": "The state of birth of person thats represents account entity",
"examples": [
"S\u00e3o Paulo"
]
},
"country_of_birth": {
"type": [
"string",
"null"
],
"title": "The country of birth of person thats represents account entity",
"examples": [
"Brasil"
]
},
"document_type": {
"type": [
"string",
"null"
],
"title": "The document type of person thats represents account entity",
"examples": [
"RG",
"CNH"
]
},
"other_id_number": {
"type": [
"number",
"null"
],
"title": "The other identifier number of person thats represents account entity",
"examples": [
123456
]
},
"document_issued_by": {
"type": [
"string",
"null"
],
"title": "When was issued the document of person representing the account entity",
"examples": [
"SSP",
"ITEP"
]
},
"document_issued_at": {
"type": [
"string",
"null"
],
"title": "Who issued document of person that's represents account entity",
"examples": [
"RJ"
]
},
"document_issued_date": {
"type": [
"integer",
"null"
],
"title": "The document issued date of person thats represents account entity",
"examples": [
"2019-07-19"
]
},
"fathers_name": {
"type": [
"string",
"null"
],
"title": "The fathers name of person thats represents account entity",
"examples": [
"Jos\u00e9"
]
},
"assets": {
"type": [
"number",
"null"
],
"title": "The assets of person thats represents account entity",
"examples": [
0.01
]
},
"occupation": {
"type": [
"string",
"null"
],
"title": "The occupation of company or person thats represents account entity",
"examples": [
"Ocupado"
]
},
"income": {
"type": [
"number",
"null"
],
"title": "The income of company or person thats represents account entity",
"examples": [
0.05
]
},
"net_worth": {
"type": [
"number",
"null"
],
"title": "The net worth of company or person thats represents account entity",
"examples": [
0.05
]
},
"partners": {
"type": [
"array",
"null"
],
"title": "The company partner information. This is a metadata, so this object returns what we receive from the entity change request"
}
}
}
}
}Updated 2 months ago