Document Signing

Elavon generates all European and North American contractual documentation on a case by case basis. Documents are in HTML or PDF format.

Document signing uses the createdocumentpacket request with allied calls designed to help facilitate the document signing process within your system. For full details, always refer to the API Reference.

The following calls are outlined on this page:

Important: When more than one Path Parameter versionNumber is available, always use the latest version. For example, when versions 1 to 4 are available, use v4.

Create Document Packet

In most implementations, this is the first API request. It provides:

  • A list of signer IDs of business owners for this and other calls.

  • A list of URLs of documents for business owners to read and, or to sign.

  • A document packet ID for ongoing reference.

Important: For security reasons, document URLs are valid for only 5 minutes and the signing session times out at 20 minutes. When timed out, you must use the Refresh Signer User Sessions call to refresh them.

Create Document Packet

Endpoint

/createdocumentpacket

operationID

createDocumentPacket

 

Back to Top

Refresh Signer User Sessions

When the document URLs expire, use this call containing the document packet and signer IDs to issue a fresh set of URLs for your merchant to sign.

Refresh Signer User Sessions

Endpoint

/refereshSignerUserSessions

operationID

refreshSignerUserSessions

 

Back to Top

Check Document Signing Status

This call confirms who has, or has not completed document signing. It contains the document packet ID and signer ID.

Check Document Signing Status

Endpoint

/checkDocumentSignerStatus

operationID

checkDocumentSigningStatus

 

Back to Top

Push Signing Status (Optional)

Implementing this call requires an Elavon software release. If you want to set up an endpoint and have us push the signing status to you, then please talk to our Solutions Engineering Team.

Back to Top

Get Unsigned Packet and Get Unsigned Document

These calls return the list of unsigned documents in the packet for collection and storage at your discretion. This call is very similar to Get Signed Packet.

Get Unsigned Packet

Endpoint

/getunsignedpacket

operationID

getUnsignedDocumentsPacketContent

 

Get Unsigned Document

Endpoint

/getunsigneddocument

operationID

getUnsignedDocumentContent

 

Back to Top

Get Signed Packet

Returns the list of all signed documents. The call is very similar to Get Unsigned Packet.

Get Signed Packet

Endpoint

/getsignedpacket

operationID

getSignedDocumentPacketContent

NA Implementations

NA implementations include additional operations to those required of EU implementations.

(NA) Retrieve Converge Credentials

Depending on your implementation, Converge credentials are returned with a MID immediately or within 5 minutes of the account’s approval.

 

Retrieve Converge Credentials

Endpoint

/api/

operationID

getconvergecredentialsrequest

 

Back to Top

(NA) Routing Number Validation Request

Invalid routing numbers cause a boarding error. This optional call is made before boarding to validate a bank routing number.

Routing Number Validation Request

Endpoint

/api/[versionNumber}/bank

operationID

bankValidate

 

Back to Top

(NA) Postal Code Validation Request

Invalid postal codes cause boarding errors. This optional call is made before boarding to validate a post code. Values in the response should be used to populate address fields in the boarding request.

Note: This currently applies only to Canadian and USA postal codes.

Postal Code Validation Request

Endpoint

/api/[versionNumber}/postal

operationID

postalValidate

 

Back to Top

(NA) eID Quiz

In the Canadian and USA regions, the eID Quiz feature meets the requirements of the Know Your Customer (KYC) guidelines.

The Quiz compares your principal applicants’ profiles against known fraudulent values. It effectively reduces the risk of boarding stolen, modified, and other high-risk identities. Fraudulent applications are declined immediately.

Depending on your implementation, our eBoarding API initiates and presents the eID Quiz to applicants who must then complete and submit it for validation before boarding.

Format the Result

For some implementations, you must extract the fraudCheckResult from the answerQuizResponse parameter block and insert it into the body of the boarding request.

Endpoints

Get Quiz Request

Endpoint

api/v1/getquiz

Input

GetQuizRequest

 

All portions of the GetQuizRequest are reused in the boarding call.

Answer Quiz Request

Endpoint

api/v1/answerquiz

Input

AnswerQuizRequest

 

Back to Top

 

Related Content

 

❮ Back to API Operations, Errors, and CodesNext: Boarding ❯