Get Unsigned Documents

In the EU, all contractual documents are generated by Elavon. They are accessed on a case by case basis using the eBoarding API.    

The following calls are described on this page:

Get Document List

This is the first document API called. The API returns a list of contractual documents needed to be distributed, reviewed, and signed for each individual application. You can choose the HTML or PDF document format.

 

Get Document List

Endpoint

/api/

Input

ListDocumentsRequest

Output

ListDocumentsResponse

 

Back to Top

Create Document Packet

This call follows the Get Document List API, which must be called first. This call:

  • Sets up the signers list and defines the URLs based on signing, not signing, or on timing out.
  • The output is a list of signer’s URLs.
  • URLs are active for 5 minutes.
  • The signing session times out at 20 minutes.

 

Create Document Packet

Endpoint

/api/

Input

CreateDocumentPacketRequest

Output

CreateDocumentPacketResponse

 

Back to Top

Refresh Signer User Sessions

This call refreshes the expiration time of the signer URLs provided in the Create Document Packet.

 

Refresh Signer User Sessions

Endpoint

/api/

Input

RefreshSignerUserSessionsRequest

Output

RefreshSignerUserSessionsResponse

 

Back to Top

Poll Signing Status

The current status of the signers is polled to check that each has completed signing.

 

Poll Signing Status

Endpoint

/api/

Input

CheckDocumentSignerStatus

Output

CreateDocumentPacketResponse

 

Back to Top

Push Signing Status

This requires an Elavon software release. If you want to set up an endpoint and have us push the signing status to you, then Contact Elavon.

 

Back to Top

Get Unsigned Documents in Packet

Returns a list of all documents that require signing.

 

Get Unsigned Documents in Packet

Endpoint

/api/

Input

GetUnsignedDocumentPacketRequest

Output

GetDocumentResponse

 

Back to Top

Get Signed Documents in Packet

Returns the list of all documents signed.

 

Get Signed Documents in Packet

Endpoint

/api/

Input

GetsignedDocumentPacketRequest

Output

GetDocumentResponse

 

Back to Top

Submit Application and Documents in Packet

Partners using Elavon’s signing feature can do a boarding request and at the same time have Elavon upload the signed documents. Use profileCode and documentPacketId in the boarding request.

 

Submit Application and Documents in Packet

Endpoint

/api/

Input

BoardRequestParams                     

Output

BoardingReponse

 

Back to Top

 

❮ Back to General Boarding   Next:  Uploading Documents Using SFTP ❯