This method is used to retrieve the KYC & AML status of a specific party. The Party ID is required as a request parameter for this method.

Request Parameters

clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
partyIdyesstringParty ID that is generated by the API when an individual party is created (createParty)

Sample Request

curl -k -X POST
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d partyId=P12345

Response Parameters

statusCodestringAPI Status Code
statusDescstringAPI Status Description
KYC StatusstringStatus
Party StatusstringStatus Array

Sample Response

  "statusCode": "101",
  "statusDesc": "Ok",
  "KYC Status":"Disapproved",
  "Party Status":{
      "AML status":"Auto Approved",
      "AML date":"08-06-2018"

Test it Yourself!

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