Skip to main content

Create TnC

POST 
/references/termsandconditions

creates a new terms and conditions object available to be signed by organisation admins on the directory

Request​

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(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)$

    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

    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.

Body

required

TnC create request

    ExternalSigningService

    object

    ExternalSigningServiceName ExternalSigningServiceName (string)

    Possible values: [DocuSign]

    The Name of the External Signing Service

    ExternalSigningServiceSignerTemplateConfig

    object

    Signer1TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 1 signer

    Signer2TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 2 signers

    Signer3TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 3 signers

    Signer4TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 4 signers

    Signer5TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 5 signers

    Signer6TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 6 signers

    ExternalSigningServiceSubject string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The Subject of the External Signing Service

    ExternalSigningServiceEmailSubject string

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[^<>]*$

    The Subject of the Email for External Signing Service

    Name stringrequired

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The Name of the TnC

    Type stringrequired

    Possible values: [Participant, Directory]

    Role for which this TnC applies

    Content stringrequired

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The MarkDown of the TnC

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

Details of the TnC item

Response Headers

  • x-fapi-interaction-id

    string

Schema

    ExternalSigningService

    object

    ExternalSigningServiceName ExternalSigningServiceName (string)

    Possible values: [DocuSign]

    The Name of the External Signing Service

    ExternalSigningServiceSignerTemplateConfig

    object

    Signer1TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 1 signer

    Signer1Version integer

    Version of the TnC document

    Signer2TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 2 signers

    Signer2Version integer

    Version of the TnC document

    Signer3TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 3 signers

    Signer3Version integer

    Version of the TnC document

    Signer4TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 4 signers

    Signer4Version integer

    Version of the TnC document

    Signer5TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 5 signers

    Signer5Version integer

    Version of the TnC document

    Signer6TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 6 signers

    Signer6Version integer

    Version of the TnC document

    ExternalSigningServiceSubject string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The Subject of the External Signing Service

    ExternalSigningServiceEmailSubject string

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[^<>]*$

    The Subject of the Email for External Signing Service

    Version integer

    Version of the TnC

    TnCId integer

    Unique identifier for the Terms and Conditions Item

    Name stringrequired

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The Name of the TnC

    Type stringrequired

    Possible values: [Participant, Directory]

    Role for which this TnC applies

    Content stringrequired

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The MarkDown of the TnC

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Loading...