Skip to main content

Edit a person's data

Request

ENDPOINT
/person/PERSON_KEY/personal_data
METHOD
PATCH

Path Params

FieldTypeDescriptionCharacters
PERSON_KEY *UUIDUnique identifier of the person36
Request Body
{
"name": "Mateus da Silva",
"date_of_birth": "1995-05-01",
"profession": "programer",
"mother_name": "Maria de Jesus",
"father_name": "João dos Santos",
"birth_place": "Taguatinga",
"spouse_name": "Luis dos anjos",
"is_pep": true,
"revenue_amount": 100.52,
"onboarding_key": "bc90744e-4f9a-42b1-9410-d5fa3c183fa8"
}

BODY PARAMS

FieldTypeDescriptionCharacters
namestringFull name-
date_of_birthstringBirth date, in the format YYYY-MM-DDdate
professionstringProfession-
mother_namestringMother's name-
father_namestringFather's name-
birth_placestringPlace of birth-
spouse_namestringSpouse's name-
is_pepBooleanDeclaration if the person is a PEP (Politically Exposed Person) (http://www.portaldatransparencia.gov.br/download-de-dados/pep).boolean
revenue_amountnumberMonthly income-
onboarding_keystringKey used for anti-fraud validationuuidv4

Response

STATUS
204
Response Body
{}
STATUS
4XX
Response Body
{
"title": "titulo",
"description": "description in English",
"translation": "description in Portuguese",
"code": "codigo"
}
HTTP CodeQI Code
code
Title
title
Description
description
Translation
translation
404OBD000019Not foundPerson not foundPessoa não encontrada.
403OBD000073UnauthorizedUser does not have permission to add or modify persons to this domainUsuário não tem permissão para adicionar ou modificar pessoas a este domínio.