Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • Authentication

Sentinel Compliance Platform uses an authentication token to authenticate requests. Each API request requires a token, which is provided via /api/auth endpoint.

...

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.

...

Code Block
app.post('/api/batch',
            isAuthenticated,
            upload.single('file'),
            postBatch
        );
  • Search

Conducting compliance searches (individual or organization) for inquires through API access. Compliance search reporting and continuous monitored screenings.

...

Request Body (json)

Code Block
{
    	"search": {
		"nameSearch": {
			        "accountId": "",
			
        "detail": {
				            "address": {
					"city
                "country": "",
					"country                "street": "",
					"postal
                "city": "",
					
                "state": "",
					"street
                "postal": ""
				},
				            },
            "annotation": false,
				"",
            "citizenship": "",
				
            "dob": {
					
                "dateOfBirth": ""
				
            },
				"dobDelta": "", 				"firstName": "", 				"lastName": "", 				"middleName": "", 				"months": "", 				"note": "", 				"phonedobDelta": "",
				"reference": false,
				"refId": "",
				"ssn": "",
				"ssn4": ""
			},
			"id": null,
			"internalId            "firstName": "bernard",
			"name": "",
			"screenDuplicates": false,
			"screeningGroupId": "",
			"status": "ready",
			"type
            "lastName": "Organizationmadoff",
			"user": {
				"email": "",
				"emailVerified": true,
				"id": "",
				"name": ""
			},
			"userId            "middleName": "",
		}, 		"options": [ 			{ 				"available": true, 				"connected": true, 				"enabled": true, 				"key": "dj", 				"nametype": "Individual"Sentinel
Dow Jones", 				"numberEntries": 50, 				"purchased": true, 				"threshold": 75 			},
			{
				"available": true,
				"connected": true,
				"enabled": false,
				"key        "organizationId": "check",
				"name": "Sentinel World Check",
				"numberEntries": 50,
				"purchased": false,
				"threshold": 75
			},
			{
				"available": true,
				"connected": true,
				"enabled": false,
				"key": "compliance",
				"name": "Sentinel World Compliance",
				"numberEntries": 50,
				"purchased": false,
				"threshold": 75
			}
		],
		"submissionType": "Manual"
	
        "screeningGroupId": "",
        "status": "ready",
        "userId": ""
    }
}