Sample Prospect Creation Request and Response in the JSON Format

Using the below example, you can create the Smith prospect person in 930 division.

Sample Prospect Creation Request in the JSON Format

{
    "C1-ADDPROSPERSON"
    {
        "actionFlag" :"ADD",
        "prospectPersonName" :"Smith",
        "division" :"930",
        "customerSegment" :"COMM",
        "customerTier" :"T",
        "accessGroup" :"***",
        "emailAddress" :"smith@example.com",
        "status" :"ACTIVE",
        "birthDate" :"2000-01-01",
        "address1" :"401",
        "address2" :"Island Parkway",
        "address3" :"Redwood Shores",
        "address4" :"Redwood Shores",
        "city" :"CA",
        "state" :"NEW YORK",
        "country" :"USA",
        "postal" :"94065",
        "prosPerIdentifierList"
        {
            "personIdNumber" :"Smith",
            "persIsPrimaryId" :"true",
            "idType" :"COREG",
        }
        "prosChildRelationList"
        {
            "childPersonId" :"3784437346",
            "personRelationshipType" :"CHILD",
            "childPerType" :"PRSP",
            "division" :"930",
            "childPersonIdType" :"Social Security number",
            "childPersonIdNumber" :"3167070400",
            "endDate" :"2025-01-01",
            "startDate" :"2019-01-01",
        }
        "prosParentPerRelationList"
        {
            "parentPersonId" :"1600395396",
            "personRelationshipType" :"CHILD",
            "parentPerType" :"EPER",
            "division" :"930",
            "parentPersonIdType" :"Social Security number",
            "parentPersonIdNumber" :"4598409119",
            "endDate" :"2025-01-01",
            "startDate" :"2019-01-01",
        }
        "prosAccountList"
        {
            "personId" :"6709873933",
            "customerClass" :"BKCORPV1",
            "accountDivision" :"930",
            "status" :"ACTIVE",
            "setUpDate" :"2021-01-01",
            "currency" :"USD",
            "billCycle" :"BKEM",
            "accountAccessGroup" :"***",
            "prosAcctCharacteristicList"
            {
                "characteristicValue" :"PROS",
                "effectiveDate" :"2025-01-01",
                "characteristicType" :"C1_F_ANO",
            }
            "prosAcctIdentifierList"
            {
                "accountIdentifierType" :"ACCT_NM",
                "isPrimaryId" :"true",
                "accountNumber" :"PROS",
            }
        }
        "prosPerCharactersticList"
        {
            "personcharacteristicValue" :"ORG",
            "personEffectiveDate" :"2025-01-01",
            "personCharType" :"ORGORFI",
        }
    }
}

Note: If you do not want to enter the data in the list attributes (i.e. attributes where the type is set to list), you should not include them in the request. Adding empty list attributes will give erroneous results.

Sample Prospect Creation Response in the JSON Format

{
    "C1-ADDPROSPERSON"
    {
        "prospectPersonId" :"7253834552",
        "actionFlag" :"ADD",
        "prospectPersonName" :"Smith",
        "division" :"930",
        "customerSegment" :"COMM",
        "customerTier" :"T",
        "accessGroup" :"***",
        "emailAddress" :"smith@example.com",
        "status" :"ACTIVE",
        "birthDate" :"2000-01-01",
        "address1" :"401",
        "address2" :"Island Parkway",
        "address3" :"Redwood Shores",
        "address4" :"Redwood Shores",
        "city" :"CA",
        "state" :"NEW YORK",
        "country" :"USA",
        "postal" :"94065",
        "prosPerIdentifierList"
        {
            "personIdNumber" :"Smith",
            "persIsPrimaryId" :"true",
            "idType" :"COREG",
        }
        "prosChildRelationList"
        {
            "childPersonId" :"3784437346",
            "personRelationshipType" :"CHILD",
            "childPerType" :"PRSP",
            "division" :"930",
            "childPersonIdType" :"Social Security number",
            "childPersonIdNumber" :"3167070400",
            "endDate" :"2025-01-01",
            "startDate" :"2018-01-01",
        }
        "prosParentPerRelationList"
        {
            "parentPersonId" :"1600395396",
            "personRelationshipType" :"CHILD",
            "parentPerType" :"EPER",
            "division" :"",
            "parentPersonIdType" :"Social Security number",
            "parentPersonIdNumber" :"4598409119",
            "endDate" :"2025-01-01",
            "startDate" :"2019-01-01",
        }
        "prosAccountList"
        {
            "personId" :"6709873933",
            "prospectAccountId" :"7649992977",
            "customerClass" :"BKCORPV1",
            "accountDivision" :"930",
            "status" :"ACTIVE",
            "setUpDate" :"2021-01-01",
            "currency" :"USD",
            "billCycle" :"BKEM",
            "accountAccessGroup" :"***",
            "prosAcctCharacteristicList"
            {
                "characteristicValue" :"PROS",
                "effectiveDate" :"2025-01-01",
                "characteristicType" :"C1_F_ANO",
            }
            "prosAcctIdentifierList"
            {
                "accountIdentifierType" :"ACCT_NM",
                "isPrimaryId" :"true",
                "accountNumber" :"PROS",
            }
        }
        "prosPerCharactersticList"
        {
            "personcharacteristicValue" :"ORG",
            "personEffectiveDate" :"2025-01-01",
            "personCharType" :"ORGORFI",
        }
    }
}

Note: We have given the above request and response samples to illustrate how the attribute value pairs should be structured while sending a prospect creation request from the external system. However, you should not seamlessly use this request sample in your environment because the required pre-requisite data may not be available in your environment. In such case, the system will give erroneous results.

Related Topics

For more information on...	See...
Prospect add request and response attribute/value pairs in the JSON format	Prospect Add Request and Response - Attribute/Value Pairs in the JSON Format