Sample Prospect Creation Request and Response in the XML Format

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

Sample Prospect Creation Request in the XML Format

<C1-ADDPROSPERSON>
    <actionFlag>ADD</actionFlag>
    <prospectPersonName>Smith</prospectPersonName>
    <division>930</division>
    <customerSegment>COMM</customerSegment>
    <customerTier>T</customerTier>
    <accessGroup>***</accessGroup>
    <emailAddress>smith@example.com</emailAddress>
    <status>ACTIVE</status>
    <birthDate>2000-01-01</birthDate>
    <address1>401</address1>
    <address2>Island Parkway</address2>
    <address3>Redwood Shores</address3>
    <address4>Redwood Shores</address4>
    <city>CA</city>
    <state>NEW YORK</state>
    <country>USA</country>
    <postal>94065</postal>
    <prosPerIdentifierList>
        <personIdNumber>smith</personIdNumber>
        <persIsPrimaryId>true</persIsPrimaryId>
        <idType>COREG</idType>
    </prosPerIdentifierList>
    <prosChildRelationList>
        <childPersonId>3784437346</childPersonId>
        <personRelationshipType>CHILD</personRelationshipType>
        <childPerType>PRSP</childPerType>
        <division>930</division>
        <childPersonIdType>Social Security number</childPersonIdType>
        <childPersonIdNumber>3167070400</childPersonIdNumber> 
        <endDate>2025-01-01</endDate>
        <startDate>2019-01-01</startDate>
    </prosChildRelationList>
    <prosParentPerRelationList>
        <parentPersonId>1600395396</parentPersonId>
        <personRelationshipType>CHILD</personRelationshipType>
        <parentPerType>EPER</parentPerType>
        <division>930</division>
        <parentPersonIdType>Social Security number</parentPersonIdType>
        <parentPersonIdNumber>4598409119</parentPersonIdNumber>
        <endDate>2025-01-01</endDate>
        <startDate>2019-01-01</startDate>
    </prosParentPerRelationList>
    <prosAccountList>
        <personId>6709873933</personId>  
        <customerClass>BKCORPV1</customerClass>
        <accountDivision>930</accountDivision>
        <status>ACTIVE</status>
        <setUpDate>2021-01-01</setUpDate>
        <currency>USD</currency>
        <billCycle>BKEM</billCycle>
        <accountAccessGroup>***</accountAccessGroup>
        <prosAcctCharacteristicList>
            <characteristicValue>PROS</characteristicValue>
            <effectiveDate>2025-01-01</effectiveDate>
            <characteristicType>C1_F_ANO</characteristicType>
        </prosAcctCharacteristicList>
        <prosAcctIdentifierList>
            <accountIdentifierType>ACCT_NM</accountIdentifierType>
            <isPrimaryId>true</isPrimaryId>
            <accountNumber>PROS</accountNumber>
        </prosAcctIdentifierList>
    </prosAccountList>
    <prosPerCharactersticList>
        <personcharacteristicValue>ORG</personcharacteristicValue>
        <personEffectiveDate>2025-01-01</personEffectiveDate>
        <personCharType>ORGORFI</personCharType>
    </prosPerCharactersticList>
</C1-ADDPROSPERSON>
Note: If you do not want to enter the data in the list tags (i.e. tags where the type is set to list), you should not include them in the request. Adding empty list tags will give erroneous results.

Sample Prospect Creation Response in the XML Format

<C1-ADDPROSPERSON>
    <prospectPersonId>7253834552</prospectPersonId>
    <actionFlag>ADD</actionFlag>
    <prospectPersonName>Smith</prospectPersonName>
    <division>930</division>
    <customerSegment>COMM</customerSegment>
    <customerTier>T</customerTier>
    <accessGroup>***</accessGroup>
    <emailAddress>smith@example.com</emailAddress>
    <status>ACTIVE</status>
    <birthDate>2000-01-01</birthDate>
    <address1>401</address1>
    <address2>Island Parkway</address2>
    <address3>Redwood Shores</address3>
    <address4>Redwood Shores</address4>
    <city>CA</city>
    <state>New York</state>
    <country>USA</country>
    <postal>94065</postal>
    <prosPerIdentifierList>
        <personIdNumber>Smith</personIdNumber>
        <persIsPrimaryId>true</persIsPrimaryId>
        <idType>COREG</idType>
    </prosPerIdentifierList>
    <prosChildRelationList>
        <childPersonId>3784437346</childPersonId>
        <personRelationshipType>CHILD</personRelationshipType>
        <childPerType>PRSP</childPerType>
        <division>930</division>
        <childPersonIdType>Social Security number</childPersonIdType>
        <childPersonIdNumber>3167070400</childPersonIdNumber> 
        <endDate>2025-01-01</endDate>
        <startDate>2018-01-01</startDate>
    </prosChildRelationList>
    <prosParentPerRelationList>
        <parentPersonId>1600395396</parentPersonId>
        <personRelationshipType>CHILD</personRelationshipType>
        <parentPerType>EPER</parentPerType>
        <division>930</division>
        <parentPersonIdType>Social Security number</parentPersonIdType>
        <parentPersonIdNumber>4598409119</parentPersonIdNumber>
        <endDate>2025-01-01</endDate>
        <startDate>2019-01-01</startDate>
    </prosParentPerRelationList>
    <prosAccountList>
        <personId>6709873933</personId>  
        <prospectAccountId>7649992977</prospectAccountId>
        <customerClass>BKCORPV1</customerClass>
        <accountDivision>930</accountDivision>
        <status>ACTIVE</status>
        <setUpDate>2021-01-01</setUpDate>
        <currency>USD</currency>
        <billCycle>BKEM</billCycle>
        <accountAccessGroup>***</accountAccessGroup>
        <prosAcctCharacteristicList>
            <characteristicValue>PROS</characteristicValue>
            <effectiveDate>2025-01-01</effectiveDate>
            <characteristicType>C1_F_ANO</characteristicType>
        </prosAcctCharacteristicList>
        <prosAcctIdentifierList>
            <accountIdentifierType>ACCT_NM</accountIdentifierType>
            <isPrimaryId>true</isPrimaryId>
            <accountNumber>PROS</accountNumber>
        </prosAcctIdentifierList>
    </prosAccountList>
    <prosPerCharactersticList>
        <personcharacteristicValue>ORG</personcharacteristicValue>
        <personEffectiveDate>2025-01-01</personEffectiveDate>
        <personCharType>ORGORFI</personCharType>
    </prosPerCharactersticList>
</C1-ADDPROSPERSON>
Note: We have given the above request and response samples to illustrate how the tags should be nested 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 tags in the XML format Prospect Add Request and Response - Tags in the XML Format