post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/performAml
* This Method has third party fees associated with it that will be charged for each use. The cost to use this method is $0.10 each time the method is invoked. (Only applies in live API environment. Does not apply in the Sandbox Environment) * Perform AML(Anti-Money Laundering) Checks for Entity Parties(createEntity).
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| clientID | yes | string | TransactAPI Client ID |
| developerAPIKey | yes | string | TransactAPI Developer Key |
| partyId | yes | string | Party ID or Entity ID that is generated by the API when an individual party or entity party is created (createParty / createEntity). |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/performAml
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d partyId=E12345
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| partyDetails | string | AML Response |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"partyDetails": {
"response": {
"id-number": "2180907751",
"restriction": {
"key": "global.watch.list.no.match",
"message": "Patriot Act - No Match"
}
},
"amlStatus": "Auto Approved"
}
}