Get Legal Agreements

Description

Gets the default and customized Legal Agreements.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
type Array of Strings Required Values can be: resellermasteragreement, customermasteragreement, resellerdomainagreement, customerdomainagreement, resellerwebserviceagreement, customerwebserviceagreement, resellerdigicertagreement, customerdigicertagreement, registraragreement, registrarregistrantagreementv2, customerhostingproductagreement or resellerhostingproductagreement.

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/commons/legal-agreements.xml?auth-userid=0&api-key=key&type=type

Response

Returns a hash map of the Legal Agreements containing the below details:

  • Default Agreement Text (defaultagreement)

  • Whether the Default Agreement has been selected for use (agreementflag)

  • Customized Agreement Text (agreement)

Example Test URL Request for Domain Registration Agreement (For Registrants)

https://test.httpapi.com/v2/commons/legal-agreements.json?type=registrarregistrantagreementv2&auth-userid=0&api-key=key

Response

Returns a hash map of the Legal Agreements containing the below details:

  • TLDs for which the agreement is valid (productkeys)

  • Registrar Name (registrar-name)

  • Agreement for Registrants (agreement)

 

In case of any errors, a status key with value as ERROR along with an error message will be returned.