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.05 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

ParameterRequiredTypeDescription
clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
partyIdyesstringParty ID that is generated by the API when an entity party is created(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

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
partyDetailsstringAML 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"
    }
}

Test it Yourself!

Language
Click Try It! to start a request and see the response here!