Get Started

Sections

Theme switcher

Upload Gateway Authorization Form

Header Parameters

Api-Keystring

Query Parameters

gatewaystring

Provide the name of the gateway that this document should be uploaded to. Currently the only supported value is "forthpay"

Body Parameters

clixsign_doc_idinteger

Provide this when uploading a signed ClixSign document. Unsigned documents are not supported.

contacts_docs_idinteger

This field is required when uploading a ClixSign document package and passing the template_ids field.

doc_idinteger

Provide this when uploading a document from the "Uploaded Files" section on the contact's dashboard.

template_idsarray

Pass this field when you want to select child documents from a package or previously merged document.
You can provide separate id types depending on if the file is a package or a document that is the result of a document merge. If you want to upload the entire document or package without selecting child documents, do not pass this field.

Select Documents From a Package:
[{"id": 1234, "type": "template"}, {"id": 12345, "type": "template"}]
Select Source Fil...

Show child attributes

Response

200
Object
File successfully uploaded

Response Attributes

statusobject

Show child attributes

responsearray
400
Object
The Authorization Form did not upload. Before trying again, check that all required fields have been completed.

Response Attributes

statusobject

Error Response Status

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?