Skip to main content

Preview Adhesion Term

This endpoint allows previewing an Adhesion Term draft for a specific operation using a predefined template.


Request

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/preview_adhesion_term
METHOD
POST

Path Params

FieldTypeDescriptionMax Characters
OPERATION-KEY *stringUnique operation key (UUID v4).36
Request Body
{
"template_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e"
}

Request Body Params

FieldTypeDescriptionRequired
template_key *stringUnique key of the new template to be used (UUID v4).Yes

Response

STATUS
201
Response Body
{
"operation_key": "a846cc4a-b542-4f66-9823-b6d5458bd127",
"document_type": "adhesion_term",
"document_base64": "dGVzdGVfZG9jdW1lbnRfYmFzZTY0"
}

Response Body Params

FieldTypeDescriptionMax Characters
operation_key *stringUnique operation key (UUID v4).36
document_type *stringType of generated document. Will always be adhesion_term.50
document_base64 *stringGenerated document content, encoded in Base64.-