Identity Enrollment

Prerequisites

Before you get started, make sure you have either a GAPI user account with access to the Identity Enrollment Service
You have existing knowledge of the GlobalGateway API.
You have generated a Token using the Token Request API Endpoint

API Endpoint

The Enrollment API Endpoint is different from the standard GlobalGateway endpoint and should only be used to enroll an entity into our Identity Enrolment Service for Ongoing Monitoring.

https://identity-enrollment.prod.trulioo.com/Enrollment/CreateEnrollmentWithIndividual

Webhook Authentication

Webhook authentication is recommended to ensure the security and integrity of the webhook from Trulioo. Authentication allows customers to verify that the webhook request is coming from Trulioo and has not been tampered with during transmission.

For Ongoing Screening, a customer's webhook is pinged whenever an entity is rescanned against watchlists, adverse media, or PEPs.

Basic Authentication

Customers will need to provide Trulioo with a username and password. The credentials will be base64 encoded and sent in the request header for each webhook.

Please reach out to Trulioo Support to enable this functionality.

OAuth

To enable OAuth webhook authentication, customers will be required to provide Trulioo with the following:

An endpoint for token generation. The token endpoint must have grant_type of client_credentials.
Client ID and Client Secret.

The bearer token generated will be sent in the request header for each webhook.

Please reach out to Trulioo Support to enable this functionality.

Example Request

POST /token HTTP/1.1
Host: customerTokenUrl.com
Authorization: Basic <clientId:clientSecret>
Content-Type: application/x-www-form-urlencoded
Content-Length: 29

grant_type=client_credentials

Sample Enrollment Request

{
  "CallbackUrl": "callbackUrl",
  "Frequency": "Monthly",
  "IndividualToMonitor": {
    "FirstName": "FirstName",
    "LastName": "LastName",
    "DateOfBirth":"YYYY-MM-DD"
  },
  "ServiceName": "Watchlist"
}

Sample API Response

{
    "Version": "1.0.0",
    "StatusCode": 200,
    "Message": "POST Request successful.",
    "Result": "EnrollmentID"
}

Sample Callback Response

{
	"VerificationDoneOnDate": "2022-11-15T21:47:11.849303",
	"EnrollmentId": "cf9ddaf7-9ed6-442c-8f8c-8c99455e9ab2",
	"MonitoringResult": {
		"WatchlistState": "Potential Hit",
		"WatchlistData": {
			"num_WL_hits": 2,
			"num_AM_hits": 2
      "num_PEP_hits": 1
		},
		"WatchlistFullName": "Tom Marvolo Riddle",
		"WatchlistHitDetails": {
			"WL_results": [{
					"score": 1,
					"individualName": "Tom Marvolo Riddle",
					"aliasList": "Lord Voldemort; You-Know-Who; He-Who-Must-Not-Be-Named; The Dark Lord",
					"identifier": "Unique ID: HW32189 | Azkaban ID: 14196",
					"subjectMatched": "Tom Marvolo Riddle",
					"dateOfBirth": "31/12/1926",
					"nationality": "British",
					"sourceListType": "Ministry of Magic Sanctions List",
					"sourceRegion": "Europe",
					"remarks": "Date Designated: 06/07/1945 | Last Updated: 18/12/1995 | Positions: Chief Death Eater",
					"caution": "Sanctions Imposed: Asset freeze, Travel Ban, No Broom List",
					"URL": "https://www.wizardingworld.com/"
				},
				{
					"score": 0.95,
					"individualName": "Tom Riddle",
					"aliasList": "Lord Voldemort; The Dark Lord",
					"identifier": null,
					"subjectMatched": "Tom Riddle",
					"dateOfBirth": "31/12/1926",
					"nationality": "British",
					"sourceListType": "The Magical Congress of the United States of America Sanctions List",
					"sourceRegion": "North America",
					"remarks": "Date Designated: 06/07/2020 | Last Updated: 18/12/2021 | Positions: Head of the Investigative Committee of Russia",
					"caution": "Sanctions Imposed: Asset freeze, Travel Ban",
					"URL": "https://www.wizardingworld.com/"
				}
			],
			"AM_results": [{
					"score": 0.95,
					"subjectMatched": "Tom Riddle",
					"text": "Hogwarts increases security against former student Tom Riddle",
					"URL": "https://thedailyprophet.net/"
				},
				{
					"score": 0.90,
					"subjectMatched": "Voldemort",
					"text": "Death Eater Terror Continues as Voldemort returns",
					"URL": "https://thedailyprophet.net/"
				}
			],
			"PEP_results": [{
					"score": 1,
					"name": "Tom Marvolo Riddle",
					"dateOfBirth": "31/12/1926",
					"country": "United Kingdom",
					"professionalHistory": ["Lord Voldemort", "You-Know-Who", "He-Who-Must-Not-Be-Named", "The Dark Lord"]
			}]
		}
	}
}

Sample Unenrollment Request

DELETE /Enrollment/EnrollmentID HTTP/1.1
Host: identity-enrollment.prod.trulioo.com
Authorization: Bearer BEARER_TOKEN

Sample Unenrollment Response

Enrollment deleted

Sample Update Frequency Request

PUT /Enrollment/EnrollmentID/frequency?frequencyName=frequencyInterval HTTP/1.1
Host: identity-enrollment.prod.trulioo.com
Authorization: Bearer BEARER_TOKEN

Frequency intervals can be found here

After the frequency update, the next scan will occur at "Date Frequency Changed + Frequency Interval." For example, if the frequency for an enrollment was updated from Monthly to Weekly on January 1st the next scan will be January 8th.

Sample Update Frequency Response

{
    "Version": "1.0.0",
    "StatusCode": 200,
    "Message": "PUT Request successful.",
    "Result": "successfully updated enrollment frequency to weekly by id d1102918-b1c9-4866-b533-1d4dbf657519"
}

Sample Get Enrollment History Request

This endpoint takes in EnrollmentID and returns all watchlist hits for the entity.

GET /Enrollment/History/EnrollmentID 
Host: identity-enrollment.prod.trulioo.com
Authorization: Bearer BEARER_TOKEN

Sample Get Enrollment History Response

{
  "StatusCode": 200,
  "Message": "GET Request successful.",
  "Result": [
    {
      "VerificationDoneOnDate": "2023-04-27T17:02:56.080978",
      "EnrollmentId": "91f4baa7-c3a0-42f9-826b-f95051c378dc",
      "MonitoringResult": {
        "WatchlistState": "Potential Hit",
        "WatchlistData": {
          "num_WL_hits": 1,
          "num_AM_hits": 0,
          "num_PEP_hits": 0
        },
        "WatchlistFullName": "Tom Marvolo Riddle",
        "WatchlistHitDetails": {
          "WL_results": [
            {
              "score": 1,
              "individualName": "Tom Marvolo Riddle",
              "aliasList": "Lord Voldemort; You-Know-Who; He-Who-Must-Not-Be-Named; The Dark Lord",
              "identifier": "Unique ID: HW32189 | Azkaban ID: 14196",
              "subjectMatched": "Tom Marvolo Riddle",
              "dateOfBirth": "31/12/1926",
              "nationality": "British",
              "sourceListType": "Ministry of Magic Sanctions List",
              "sourceRegion": "Europe",
              "remarks": "Date Designated: 06/07/1945 | Last Updated: 18/12/1995 | Positions: Chief Death Eater",
              "caution": "Sanctions Imposed: Asset freeze, Travel Ban, No Broom List",
              "URL": "https://www.wizardingworld.com/"
            }
          ],
          "AM_results": [],
          "PEP_results": []
        }
      }
    }
  ]
}