All pages
Powered by GitBook
1 of 1

Loading...

Activate person

Use case

This example presents how to activate a person from PENDING status to ACTIVE.

In this example, we will demonstrate how to activate a recently created private individual, Ashley Tuum, as she has passed all pre-activation checks.

Use case data
API parameters with values

The personId of the Ashley Tuum is ID-29367.

...persons/ID-29367/activate

Sample API call

To activate the person, make the following API call.

Sample request

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

No request body.

curl --location --request POST 'https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-29367/activate' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDUtMjlUMTQ6MzM6MDAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE3MTY5OTMxODB9.hIvk230HwvSX2BMWxas_P7Xq8WyGfAEzeZsPz_U0ITY' \
--header 'x-channel-code: SYSTEM' \
--header 'Accept-Language: en' \
--data''

Sample response

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

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "personId": "ID-29367",
        "statusCode": "ACTIVE",
        "source": null,
        "tenantCode": "MB",
        "forgotten": false,
        "legalForm": null,
        "creationDate": "2024-05-29",
        "personalInfo": {
            "personTypeCode": "P",
            "givenName": "Tuum",
            "middleName": null,
            "surname": "Ashley",
            "name": null,
            "email": null,
            "phoneNumber": null,
            "phoneCountryCode": null,
            "residencyCountryCode": null,
            "sex": null,
            "nationality": null,
            "dependantPersons": null,
            "legalForm": null,
            "identificationNumber": {
                "idNumberId": "ID-3390",
                "personId": "ID-29367",
                "idNumber": "testidddd",
                "idCountryCode": "GB",
                "vatNumber": null,
                "taxNumber": null,
                "validityRange": {
                    "startTime": "2024-05-29T13:29:50.225Z",
                    "endTime": null
                }
            }
        },
        "additionalInfo": {
            "birthDate": null,
            "countryOfBirth": null,
            "placeOfBirth": null,
            "language": null,
            "educationCode": null,
            "maritalStatusCode": null,
            "dependantPersons": null,
            "taxResidencyCountry": null,
            "usResident": false,
            "pep": false,
            "customerTypeCode": null,
            "statusCodeReason": null,
            "deathDate": null,
            "liquidationDate": null,
            "inactivationDate": null,
            "tradingName": null,
            "registrationDate": null,
            "webAddress": null,
            "pepExplanation": null,
            "businessAreaCodes": [],
            "businessModelDescription": null,
            "intraOrgCode": null,
            "counterpartySectorCode": null
        },
        "work": {
            "activityCode": null,
            "businessAreaCode": null,
            "businessAreaCodes": [],
            "employmentTimeCode": null,
            "fixedEmploymentLength": null
        },
        "home": null,
        "addresses": [
            {
                "addressId": "ID-28849",
                "personId": "ID-29367",
                "addressTypeCode": "R",
                "street1": "24 Botley Road",
                "street2": null,
                "cityCounty": "Middleton Hall",
                "stateRegion": null,
                "zip": "NE71 3LL",
                "countryCode": "GB",
                "moveInDate": null,
                "validityRange": {
                    "startTime": "2024-05-29T13:29:50.118Z",
                    "endTime": null
                }
            }
        ],
        "documents": [],
        "relationships": [],
        "additionalContacts": [],
        "personGroupCodes": [],
        "identificationNumbers": [
            {
                "idNumberId": "ID-3390",
                "personId": "ID-29367",
                "idNumber": "testidddd",
                "idCountryCode": "GB",
                "validityRange": {
                    "startTime": "2024-05-29T13:29:50.225Z",
                    "endTime": null
                },
                "primary": true
            }
        ],
        "taxNumbers": [],
        "accessRestricted": false,
        "fullName": "Tuum Ashley"
    }
}

Result

A private person Ashley Tuum has been activated.

The ability to use the endpoint depends on the platform settings of your company Tuum instance. The enabled configuration ensures that the status of the newly created person is set to PENDING.

https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-29367/activate

Learn more about the endpoint in the Tuum developer portal.

activate person
activate person