Add applicant tags

Adds custom tags to applicant profiles.


Use this method to add custom tags to applicant profiles.



  • The maximum number of tags in an applicant profile is limited to 30. To remove unnecessary tags, use this method.
  • To manage tags added with this method, use the Tags page in the Dashboard.
  • To add new tags and overwrite the existing ones, use this method.


Did you know?

You can also add custom tags from the Dashboard.

Request example

curl -X POST '' \
  -H 'Content-Type: application/json' \
  -d '["Approved Sanctions", "Approved PEP", "821"]'

Response explained

If the tags are created and assigned correctly, you will get the following response:

    "ok": 1

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error.

For example:

  "description": "Invalid id 'xfghnfg'",
  "code": 400,
  "correlationId": "77b612a1bb281c64c132dd0000000000"
Click Try It! to start a request and see the response here!