post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/performKycAmlBasic
* This Method has third party fees associated with it that will be charged for each use. The cost to use this method is $0.75 each time the method is invoked. (Only applies in live API environment. Does not apply in the Sandbox Environment) * This method is used to perform KYC(Know Your Customer) checks and AML(Anti-Money Laundering) checks for Individual Parties Contact [email protected] to get instructions on how to test KYC/AML in our sandbox environment.
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| clientID | yes | string | TransactAPI Client ID |
| developerAPIKey | yes | string | TransactAPI Developer Key |
| partyId | yes | string | Party ID that is generated by the API when an individual party is created(createParty) |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/performKycAmlBasic
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d partyId=P12345
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| kyc | string | Response from IDology |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"kyc": {
"response": {
"id-number": "3298151570",
"summary-result": {
"key": "id.success",
"message": "PASS"
},
"results": {
"key": "result.match",
"message": "ID Located"
},
"qualifiers": {
"qualifier": [
{
"key": "resultcode.address.does.not.match",
"message": "Address Does Not Match"
},
{
"key": "resultcode.street.number.does.not.match",
"message": "Street Number Does Not Match"
}
]
},
"idnotescore": "0"
},
"kycstatus": "Auto Approved",
"amlstatus": "Auto Approved"
}
}