Create a Party

Prerequisites: Provided Subscription Key and Account Key.

Authentication

Click here to view the request to authorize an account.

  1. Click “Try it” to begin building the authorize account request.

  2. Enter your Subscription Key into the Subscription Key header field.

  3. In the request body paste your Account Key.

  4. Click the send button at the bottom of the screen.

  5. The response is a json object that contains the authentication token.

The authentication token and the subscription key are required on subsequent requests to the IntelAgree API.

 Add Party

Click here to view the request to create a party.

  1. Click “Try it” to begin building the Create Party request.

  2. Enter your Subscription Key into the Subscription Key header field.

  3. Add an Authorization header to the request and paste the previously requested authentication token into the value of the header.

    1. Example – Authorization: Bearer {{authToken}}

  4. Build the request body.

    1. name - name of the party

    2. legalDescription - a string representation of the legal description

    3. addressLine1 - a string representation of the first address line

    4. addressLine2 (optional) - a string representation of the second address line

    5. city (optional) - a string representation of the expiration date

    6. stateProvince (optional) – this object can be used to identify the parent Contract Key

    7. postalCode – a string representation of the postal code

    8. isConfidential – a Boolean representation used to determine if the Party is/is not confidential

    9. parentBusinessKey (optional) - this object can be used to identify the parent Party Key

      1. Example – [{"name": "{{businessSystem}}", "value": "{{businessKey}}"]

    10. businessKeys – a collection of business keys to identify the Party Key

      1. Example – [{"entity": "Party", "name": "{{businessSystem}}", "value": "{{businessKey}}"]

 

Additional Documentation:

https://apim-portal.intelagree.com/apis