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:

Important. For full details, please refer to the examples in our API Reference and, or download the YAML file for your inspection.

List Documents

This is the first API called. The API returns the list of contractual documents needed to be distributed, reviewed, and signed for each application. Documents can be retrieved in HTML or PDF format.

Note. The next call in sequence depends on who is to display and track documentation. You will be advised when to use the packet-less flow (getdocuments) or the packet flow (createdocumentpacket). 

 

Get Document List

Endpoint

/listDocuments

Input

listDocumentsRequest

Output

listDocumentsResponse

 

Back to Top

Create Document Packet

Using the packet flow, this call follows the List Documents 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

/createDocumentPacket

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

/refereshSignerUserSessions

Input

refreshSignerUserSessionsRequest

Output

refreshSignerUserSessionsResponse

 

Back to Top

Check Signing Status

The status of signers is checked for who has, or has not completed document signing.

 

Poll Signing Status

Endpoint

/checkDocumentSignerStatus

Input

checkDocumentSigningStatusRequest

Output

checkDocumentSigningStatusResponse

 

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

Lists the documents that require signing.

 

Get all Unsigned Documents from a Packet

Endpoint

/getunsignedPacket

Input

getUnsignedPacketRequest

Output

getUnsignedPacketResponse

 

Get an Unsigned Document from a Packet

Endpoint

/getUnsignedDocument

Input

getUnsignedDocumentRequest

Output

getUnsignedDocumentResponse

Back to Top

Get Signed Documents in Packet

Returns the list of all documents signed.

 

Get Signed Documents in Packet

Endpoint

/getsignedPpacket

Input

getSignedPacketRequest

Output

getSignedPacketResponse

 

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 Getting Started    Next:  Credit Check Flow ❯