Create a Party

Prerequisites:

  • You have the Subscription Key and Account Key that are needed for authentication. If you need these, speak with your IntelAgree Account Manager or Implementation Manager.

  • You have a valid authentication token

    Please see the Getting Started page for more information about how to obtain an authentication token, as well as a description of Business Keys and Impersonation, which are used when you create a Party. You can also download a Postman file from that page, which contains this and all other API operations so that you can test them.

 Add Party

To create a Party, you will call the POST /parties operation with the following information:

Headers:

  • "ApiVersion": "2.0", Required to specifiy version 2 of the API.

  • "Ocp-Apim-Subscription-Key": Your subscription key. Required for all calls to the API

  • "Authorization": Your authorization Bearer token. Required for all authenticated calls to the API.

  • "AsUserType": The BusinessKeyType for the user that is creating the party. Required, since user impersonation is required to create a party.

  • "AsUserKey": The BusinessKey Value for the user that is creating the party. Required, since user impersonation is required to create a party.

Request Body:

  • "name": Required string. The name of the Party

  • "alias": Optional string. An alternate name for the Party

  • "legalDescription": Optional string. The Party's legal description

  • "addressLine1": Optional string. The Party's first address line

  • "addressLine2": Optional string. The Party's second address line

  • "city": Optional string. The Party's address city

  • "stateProvince": Optional string. The Party's address state/province

  • "postalCode": Optional string. The Party's address postal code

  • "notes": Optional string. A place to associate notes to the Party

  • "businessKeys": An optional collection of one or more BusinessKeys to associate to the Party

  • "parentPartyKey": An optional BusinessKey that identifies the Party that should be the Parent of the new Party

  • "defaultNonSigningRecipients": Optional string. A colon-separated list of emails that should be sent copies of the Party's contracts

  • "isSelfManaged": Optional boolean: Indicates whether the Party is self-managed

  • "isConfidential": Optional boolean: Indicates whether the Party should only be seen by users that can view confidential information