Authentication, Search and Batch API's
- Tessa Vitt (Unlicensed)
- Jordan Kaiser
Authentication
Sentinel Compliance Platform uses an authentication token to authenticate requests. Each API request requires a token, which is provided via /api/auth endpoint.
{
"username": "account@domain.com",
"password": "HelloWorld"
}With this method, the sender places a username and password into the request body to get their token. This is an HTTPS request, which means the message content will be encrypted within the HTTP transport protocol.
Batch
Batch file upload searches provided through the batch API. It will post your searches provided through API’s to provide functionality to users.
POST REQUEST
Use this API endpoint to upload batch files
POST https://api.truthtechnologies.com/api/batchHeaders
Content-Type: form-data
Authorization: {{fcmToken}}Request Body
options[delimiter]: /t, comma, |, or ;
options[header]: boolean // Include Header Row
options[name]: text
file: /path/to/local/fileSearch
Conducting compliance searches (individual or organization) for inquires through API access. Compliance search reporting and continuous monitored screenings.
Use this API endpoint to conduct an individual search or organization search
https://api.truthtechnologies.com/api/searchHeaders
Content-Type: application/json
Authorization: {{fcmToken}}
Request Body (json)
{
"search": {
"accountId": uuid,
"detail": {
"address": {
"country": string,
"street": string,
"city": string,
"state": string,
"postal": string
},
"annotation": string,
"citizenship": string,
"dob": {
"dateOfBirth": string
},
"dobDelta": integer,
"firstName": string,
"lastName": string,
"middleName": string,
"type": string //Individual or Organization
},
"organizationId": uuid,
"screeningGroupId": uuid,
"status": "ready",
"userId": uuid
}
}
/* Required: Account ID, Organization ID, Group ID, User ID, Last Name, Type */