1 of 3

Find person

This guide will help you find details about an individual or a legal entity.

Based on your use case, use either of the endpoints to retrieve person data:

Find person details

Use case

Learn how to find a particular person's (your customer's) main details in Tuum. In this example, we will demonstrate it on a private person using the following data.

Use case data

API parameters with values

Private person with Tuum personId: ID-3392

.../persons/ID-3392

To retrieve the record of a legal entity, use the same API endpoint.

Sample API call

To retrieve customer data, make the following API call.

Sample request

Below is an example request of the API call to retrieve customer data.

No request body.

curl 'https://person-api.sandbox.tuumplatform.com/api/v3/persons/ID-3392' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMDFUMDg6NTU6NDciLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODU2MDk3NDd9.55aYdFuNopFjauFv8XG-FO6S5io6c4PNlF__rUIJixM' \
-H 'x-channel-code: SYSTEM'

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "personId": "ID-3392",
        "personTypeCode": "P",
        "statusCode": "ACTIVE",
        "statusCodeReason": null,
        "name": null,
        "givenName": "Trevor",
        "middleName": null,
        "surname": "Tuum",
        "birthDate": null,
        "creationDate": "2023-06-01",
        "deathDate": null,
        "liquidationDate": null,
        "inactivationDate": null,
        "registrationDate": null,
        "sex": null,
        "email": null,
        "customerTypeCode": null,
        "nationality": null,
        "taxResidencyCountry": null,
        "placeOfBirth": null,
        "countryOfBirth": null,
        "phoneCountryCode": null,
        "phoneNumber": null,
        "idNumber": "DQ654327C",
        "idCountryCode": "GB",
        "residencyCountryCode": null,
        "language": null,
        "educationCode": null,
        "activityCode": null,
        "housingTypeCode": null,
        "buildingTypeCode": null,
        "moveInDate": null,
        "maritalStatusCode": null,
        "dependantPersons": null,
        "employmentTimeCode": null,
        "fixedEmploymentLength": null,
        "businessAreaCode": null,
        "intraOrgCode": null,
        "tradingName": null,
        "webAddress": null,
        "pepExplanation": null,
        "legalForm": null,
        "businessModelDescription": null,
        "counterpartySectorCode": null,
        "forgotten": null,
        "usResident": false,
        "pep": false,
        "source": null,
        "tenantCode": "MB",
        "fullName": "Trevor Tuum"
    }
}

Result

The result of the API call is the dataset of the particular person.

Find person addresses

Use case

Learn how to find a particular person's addresses in Tuum. In this example, we will demonstrate it on a private person using the following data.

Use case data

API parameters with values

Private person with Tuum personId: ID-3392.

.../persons/ID-3392/addresses

To retrieve the record of a legal entity, use the same API endpoint.

Sample API call

To retrieve customer data, make the following API call.

Sample request

Below is an example request of the API call to retrieve person addresses.

No request body.

curl --location 'https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-3392/addresses' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDUtMjFUMTA6NTc6MzIiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE3MTYyODkwNTJ9.nz1Fm5JV4tgUvL9rD-PbVb_fBVbIgbbxDhVpPdp6h2Q' \
--header 'x-channel-code: SYSTEM' \
--data ''

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": [
        {
            "addressId": "ID-3052",
            "personId": "ID-3392",
            "addressTypeCode": "R",
            "street1": "85 Park End St",
            "street2": null,
            "cityCounty": "Broomhill",
            "stateRegion": null,
            "zip": "NE65 0YW",
            "countryCode": "GB",
            "moveInDate": null,
            "validityRange": {
                "endTime": null,
                "startTime": "2023-06-01T07:55:53.213023Z"
            }
        }
    ]
}

Result

The result of the API call is the overview of the addresses linked to the person.

Find person addresses

Use case

Learn how to find a particular person's addresses in Tuum. In this example, we will demonstrate it on a private person using the following data.

Use case data

API parameters with values

Private person with Tuum personId: ID-3392.

.../persons/ID-3392/addresses

To retrieve the record of a legal entity, use the same API endpoint.

Sample API call

To retrieve customer data, make the following API call.

https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-3392/addresses

Learn more about the endpoint in the Tuum developer portal.

Sample request

Below is an example request of the API call to retrieve person addresses.

No request body.

curl --location 'https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-3392/addresses' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDUtMjFUMTA6NTc6MzIiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE3MTYyODkwNTJ9.nz1Fm5JV4tgUvL9rD-PbVb_fBVbIgbbxDhVpPdp6h2Q' \
--header 'x-channel-code: SYSTEM' \
--data ''

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": [
        {
            "addressId": "ID-3052",
            "personId": "ID-3392",
            "addressTypeCode": "R",
            "street1": "85 Park End St",
            "street2": null,
            "cityCounty": "Broomhill",
            "stateRegion": null,
            "zip": "NE65 0YW",
            "countryCode": "GB",
            "moveInDate": null,
            "validityRange": {
                "endTime": null,
                "startTime": "2023-06-01T07:55:53.213023Z"
            }
        }
    ]
}

Result

The result of the API call is the overview of the addresses linked to the person.

Find person details

Use case

Learn how to find a particular person's (your customer's) main details in Tuum. In this example, we will demonstrate it on a private person using the following data.

Use case data

API parameters with values

Private person with Tuum personId: ID-3392

.../persons/ID-3392

To retrieve the record of a legal entity, use the same API endpoint.

Sample API call

To retrieve customer data, make the following API call.

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

Learn more about the endpoint in the Tuum developer portal.

Sample request

Below is an example request of the API call to retrieve customer data.

No request body.

curl 'https://person-api.sandbox.tuumplatform.com/api/v3/persons/ID-3392' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMDFUMDg6NTU6NDciLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODU2MDk3NDd9.55aYdFuNopFjauFv8XG-FO6S5io6c4PNlF__rUIJixM' \
-H 'x-channel-code: SYSTEM'

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "personId": "ID-3392",
        "personTypeCode": "P",
        "statusCode": "ACTIVE",
        "statusCodeReason": null,
        "name": null,
        "givenName": "Trevor",
        "middleName": null,
        "surname": "Tuum",
        "birthDate": null,
        "creationDate": "2023-06-01",
        "deathDate": null,
        "liquidationDate": null,
        "inactivationDate": null,
        "registrationDate": null,
        "sex": null,
        "email": null,
        "customerTypeCode": null,
        "nationality": null,
        "taxResidencyCountry": null,
        "placeOfBirth": null,
        "countryOfBirth": null,
        "phoneCountryCode": null,
        "phoneNumber": null,
        "idNumber": "DQ654327C",
        "idCountryCode": "GB",
        "residencyCountryCode": null,
        "language": null,
        "educationCode": null,
        "activityCode": null,
        "housingTypeCode": null,
        "buildingTypeCode": null,
        "moveInDate": null,
        "maritalStatusCode": null,
        "dependantPersons": null,
        "employmentTimeCode": null,
        "fixedEmploymentLength": null,
        "businessAreaCode": null,
        "intraOrgCode": null,
        "tradingName": null,
        "webAddress": null,
        "pepExplanation": null,
        "legalForm": null,
        "businessModelDescription": null,
        "counterpartySectorCode": null,
        "forgotten": null,
        "usResident": false,
        "pep": false,
        "source": null,
        "tenantCode": "MB",
        "fullName": "Trevor Tuum"
    }
}

Result

The result of the API call is the dataset of the particular person.