getKycAmlResponse

This method is used to get all information about an individual Party. The Party ID and type must be specified as a request parameter to get the party KYC AML information.

Request Parameters

ParameterRequiredTypeDescription
clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
partyIdyesstringParty ID that is generated by the API once an individual party is created (createParty).
typeyesstringType (This will be either Basic, Enhanced or AML Only)

Sample Request

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getKycAmlResponse
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d partyId=P79443
 -d type=basic

Response Parameters

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
kycamlDetailsstringList of party includes recent KYC/AML information of the match party

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "kycamlDetails": {
        "statusCode": "101",
        "statusDesc": "Ok",
        "kyc": {
            "response": {
                "id-number": "3429150818",
                "summary-result": {
                    "key": "id.success",
                    "message": "PASS"
                },
                "results": {
                    "key": "result.match",
                    "message": "ID Located"
                },
                "qualifiers": {
                    "qualifier": {
                        "key": "resultcode.zip.does.not.match",
                        "message": "ZIP Code Does Not Match"
                    }
                },
                "idnotescore": "0"
            },
            "kycstatus": "Auto Approved",
            "amlstatus": "Auto Approved"
        }
    }
}

Test it Yourself!

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