Appearance
PEP and Sanctions Verifications
Our PEP and Sanctions Verifications API provides comprehensive screening capabilities for Politically Exposed Persons (PEP) and individuals or entities on global sanctions lists. This service is designed to help your organization comply with regulatory requirements and mitigate risks associated with financial crimes, such as money laundering and terrorist financing.
POST
Create a PEP Verification
API
Description: Create a new PEP Verification
Endpoint: POST /api/v4/pep_checks
Properties:
Property | Required | Type | Notes |
---|---|---|---|
reference | true | String | Verification reference. A name to recognise the verification |
date_of_birth | true | String | DD/MM/YYYY |
firstname | true | String | |
lastname | true | String | |
middle_name | false | String |
Sample Response:
json
{
"id": 6,
"firstname": "John",
"lastname": "Doe",
"reference": "TEST-API",
"date_of_birth": "1966-06-06",
"created_at": "2024-06-03T13:16:48.563+12:00",
"updated_at": "2024-06-03T13:16:48.563+12:00",
"expires_at": "2024-06-10T13:16:47.605+12:00",
"is_pep_watchlist_clear": true,
"exported_by": null,
"created_by": "Lionel Weissnat"
}
GET
Export PEP and Sanctions Verification to PDF report
API
Description: Download PDF Report of PEP verification and archive from our server
Endpoint: GET /api/v4/pdf/pep_checks/:id
Examples
js
const http = require('axios')
http.post('https://integration.aplyid.co.uk/api/v4/pep_checks', {
reference: "TEST",
firstname: "John",
middle_name: "J",
lastname: "Doe",
date_of_birth: "06/06/1966"
}, {
headers: {
'Aply-API-Key': 'YOUR_API_KEY',
'Aply-Date': 'YOUR_DATE',
'Aply-Signature': 'YOUR_GENERATED_SIGNATURE'
}
}).then(response => {
// Do some stuff
}).catch(error => {
console.log(error.response.data.message)
})
Error Codes
401 Unauthorized
json
{
"error_code": "AUTH_FAILED",
"message": "Bad credentials"
}
403 Forbidden
json
{
"error_code" : "FORBIDDEN",
"message" : "You're not authorized to access this resource"
}