Perform Enhanced KYC and AML

***** This Method has third party fees associated with it that will be charged for each use. The cost to use this method is $1.57 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 techsupport@northcapital.com to get instructions on how to test KYC/AML in our sandbox environment.

Request Method : POST

Request Parameters

Parameter Required Type Description
clientID yes string Transact API Client ID
developerAPIKey yes string Transact API Developer Key
partyId yes integer 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/performKycAml 
-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 Questions related to the party

Sample Response

{
   "statusCode":"101",
   "statusDesc":"Ok",
   "kyc":{
      "response":{
         "id-number":"3028167143",
         "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",
         "questions":{
            "question":[
               {
                  "prompt":"Between 1979 and 1980, in which State did you live?",
                  "type":"prior.residence.state.multiyear",
                  "answer":[
                     "NORTH DAKOTA",
                     "NEW YORK",
                     "NEBRASKA",
                     "None of the above"
                  ]
               },
               {
                  "prompt":"What is the approximate square footage of the property at 222333 PEACHTREE PLACE?",
                  "type":"property.size",
                  "answer":[
                     "1,000 or less",
                     "1,001 - 1,500",
                     "1,501 - 2,000",
                     "2,001 - 2,500",
                     "Over 2,500",
                     "None of the above"
                  ]
               },
               {
                  "prompt":"Which person is not a relative or someone that you know?",
                  "type":"person.not.known",
                  "answer":[
                     "SUSAN BROWN",
                     "PORTER SMITH",
                     "DAVID BROWN",
                     "None of the above"
                  ]
               },
               {
                  "prompt":"At which of the following addresses have you lived?",
                  "type":"previous.address",
                  "answer":[
                     "3 CRESSING CT",
                     "4344 BACKTRAIL DR",
                     "1084 BPEACHTREE CT",
                     "None of the above"
                  ]
               },
               {
                  "prompt":"In which city is ANY STREET?",
                  "type":"city.of.residence",
                  "answer":[
                     "ALMO",
                     "ATLANTA",
                     "MINOT",
                     "None of the above"
                  ]
               }
            ]
         }
      },
      "kycstatus":"Auto Approved",
      "amlstatus":"Auto Approved"
   }
}
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

Marketplace-as-a-Service