Headers

• x-fapi-auth-date string

  The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

  Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.

• x-fapi-customer-ip-address string

  The PSU's IP address if the PSU is currently logged in with the TPP.

• x-fapi-interaction-id string

  An RFC4122 UID used as a correlation id.

• x-customer-user-agent string

  Indicates the user-agent that the PSU is using.

Path parameters

• OrganisationId string Required

  The organisation ID

  Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.

Responses

• 200 application/json

  Details of the TnC and external signing service

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attributes Show response attributes object

  • InitiatedBy string

    Email of the user who initiated the External signing for this participant

  • Role string

    Role of the user who initiated the External signing for this participant

  • TermsAndConditionsDetail object

    TnC details Parent

    Hide TermsAndConditionsDetail attributes Show TermsAndConditionsDetail attributes object

    • ExternalSigningServiceEnvelopeId string

      The envelope id of the ess signing request

      Format should match the following pattern: ^[^<>]*$.

    • ExternalSigningServiceEnvelopePasscode string

      Access code for the specifier to fill in the signer details. This will be populated only once, when signing is initiated

    • ExternalSigningServiceEnvelopeStatus

      Values are completed, created, declined, deleted, delivered, processing, sent, signed, template, voided, expired, or reissued.

    • InititatedDate string

      Terms and Conditions initiated date

      Maximum length is 255.

    • TermsAndConditionsItem object
      Hide TermsAndConditionsItem attributes Show TermsAndConditionsItem attributes object

      • ExternalSigningService object
        Hide ExternalSigningService attributes Show ExternalSigningService attributes object

        • ExternalSigningServiceEmailSubject string

          The Subject of the Email for External Signing Service

          Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[^<>]*$.

        • ExternalSigningServiceName string

          The Name of the External Signing Service

          Value is DocuSign.

        • ExternalSigningServiceSignerTemplateConfig object
          Hide ExternalSigningServiceSignerTemplateConfig attributes Show ExternalSigningServiceSignerTemplateConfig attributes object

          • Signer1TemplateId string

            Template ID for 1 signer

            Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

          • Signer1Version integer

            Version of the TnC document

          • Signer2TemplateId string

            Template ID for 2 signers

            Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

          • Signer2Version integer

            Version of the TnC document

          • Signer3TemplateId string

            Template ID for 3 signers

            Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

          • Signer3Version integer

            Version of the TnC document

          • Signer4TemplateId string

            Template ID for 4 signers

            Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

          • Signer4Version integer

            Version of the TnC document

          • Signer5TemplateId string

            Template ID for 5 signers

            Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

          • Signer5Version integer

            Version of the TnC document

          • Signer6TemplateId string

            Template ID for 6 signers

            Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

          • Signer6Version integer

            Version of the TnC document

        • ExternalSigningServiceSubject string

          The Subject of the External Signing Service

          Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

      • Version integer

        Version of the TnC

      • Content string Required

        The MarkDown of the TnC

        Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

      • Name string Required

        The Name of the TnC

        Minimum length is 1. Format should match the following pattern: ^[^<>]*$.

      • RoleIds array[string(uuid)]

        Array of Unique identifiers for the Authorisation Domain Roles the Terms and Conditions Item is linked to

        Maximum length of each is 40.

      • Status string

        Current status of this resource

        Values are Active or Inactive. Default value is Active.

      • TnCId integer

        Unique identifier for the Terms and Conditions Item

      • Type string Required

        Role for which this TnC applies

        Values are Participant or Directory.

• 400 application/json

  Bad Request

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attribute Show response attribute object

  • errors array[string]

    Validation Error messages

• 401

  Unauthorized

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 403

  Forbidden

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 404 application/json

  Not found

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attribute Show response attribute object

  • errors array[string]

    Validation Error messages

• 429

  Too many requests, maximum capacity reached. Requests are now throttled.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 500

  Internal Server Error

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 502

  Bad Gateway

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 504

  Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.