This page keeps a record of changes to our API Reference:
Added
- An example
404
response to the Get AML client by your ID and Get AML client by our ID requests - The following attributes for Physical Proof of Address in the XML file and Get case status response:
DocumentSubType
,ValidityInDays
, andHolderName
Jul 12, 2024
Changed
We changed the structure of the AML Screening & Monitoring webhook.
Jun 3, 2024
Improved
We clarified:
- The Get signature status response when multiple errors are thrown
- The
riskRequirements
object in the Upload identity data request is always optional
Removed
We removed the Get WebView URL endpoint because it doesn't support Workflows integration.
May 27, 2024
Changed
We changed the names of the following requests to clarify that you should download the full CDD Report zipfile, instead of just the PDF report:
- Get case zipfile > Get CDD zipfile
- Get CDD Report > Get CDD PDF
May 14, 2024
Added
We added the Get client profile request.
May 6, 2024
Changed
We renamed the Delete AML client request to Deactivate AML client to clarify that no data is deleted when AML client profiles are deactivated.
Added
We added new endpoints for clearing a client’s ID document data from their profile so they can re-start an Identity Verification workflow with the same document.
Apr 30, 2024
Added
We added the following endpoints for managing your sensitivity list:
- Add sensitive client
- Update sensitive client
- Remove sensitive client
- Get sensitive client
- Get all sensitive clients
Apr 5, 2024
Added
We added new versions (v4) of the following AML endpoints to enable filtering by hit type:
Apr 3, 2024
Added
We added a new Set test outcome endpoint to set a specific status and status code for an Identity Verification case for testing purposes.
Removed
We removed the unnecessary previousDocumentData
object from the Identity Verification Upload identity data request.
Mar 26, 2024
Added
To help users get the most out of our API Reference and learn to read this style of documentation, we added a video tour!
Mar 21, 2024
Removed
We removed the following unnecessary objects from:
- Create Client Authentication:
tax
profession
riskRequirements
previousDocumentData
- Create Document Authentication:
tax
profession
riskRequirements
Mar 14, 2024
Added
We have moved our webhook notification references from the Guides section to the API Reference.
Feb 21, 2024
Added
To account for the introduction of gender-neutral passports in many European countries, in all gender
enums, we have added Other
.
This is in addition to Female
, Male
, and Unknown
.
For example, see Upload identity data > RAW_BODY
object > person
object.
Changed
To better reflect the POST method, we have renamed the Get access token
request to Create access token.
Feb 20, 2024