Update personal info

Use case

Here you can learn how to update a record of a particular person (your customer) in Tuum. In this example, we will demonstrate how to update the record of a private person using the following data.

Use case data	API parameters with values
Updating private person with Tuum personId: ID-3392.	...persons/ID-3392/personal
Adding the middleName: Harry.	"middleName": "Harry"

The person record in the example below is updated with a minimum data set. In the same way, you can update a person with a richer data set.

Sample API call

To update the particular person's record, make the following API call.

https://person-api.sandbox.tuumplatform.com/api/v2/persons/ID-3392/personal

Learn more about the update personal info endpoint in the Tuum developer portal.

Sample request

Below is an example request of the API call to update the particular customer's data.

JSON

{
    "surname": "Tuum",
    "givenName": "Trevor",
    "middleName": "Harry",
    "identificationNumber": {
        "idNumberId": "ID-1770",
        "idNumber": "DQ654327C",
        "idCountryCode": "GB"
    }
}

cURL

curl --location --request PUT 'https://person-api.sandbox.tuumplatform.com/api/v2/persons/ID-3392/personal' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHBpcnlEVGltZSI6IjIwMjQtMDctMjRUMTE6MjU6NTMiLCJleHAiOjE3MjE4MjAzNTMsInJvbGVzIjpbIkFETUlOIl19.G-2NqlqmoHvoBRj3666a-Lv8VGRUybpX-ta4UPRpcsQ' \
--header 'x-channel-code: SYSTEM' \
--header 'Content-Type: application/json' \
--data '{
    "surname": "Tuum",
    "givenName": "Trevor",
    "middleName": "Harry",
    "identificationNumber": {
        "idNumberId": "ID-1770",
        "idNumber": "DQ654327C",
        "idCountryCode": "GB"
    }
}'

When using the example request, please change the x-auth-token to the one you obtained with your authentication API call.

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "personTypeCode": "P",
        "givenName": "Trevor",
        "middleName": "Harry",
        "surname": "Tuum",
        "name": null,
        "email": null,
        "phoneNumber": null,
        "phoneCountryCode": null,
        "residencyCountryCode": null,
        "sex": null,
        "nationality": null,
        "dependantPersons": null,
        "legalForm": null,
        "identificationNumber": {
            "idNumberId": "ID-1770",
            "personId": "ID-3392",
            "idNumber": "DQ654327C",
            "idCountryCode": "GB",
            "vatNumber": null,
            "taxNumber": null,
            "validityRange": {
                "startTime": "2023-06-01T07:55:53.37628Z",
                "endTime": null
            }
        }
    }
}

Result

The middleName of the private person is updated.