Complementary API Calls

Using the APIs

The following requests and associated responses are an optional collection of calls. They can be made prior to and after boarding and provide additional functionality to the main boarding call.

Types and objects used in these calls that are also used in boarding are documented in the Boarding process.

Boarding Status Request

  • Made after boarding to receive status of application and final MID.
  • Possible responses are defined in BoardingStatusResponse in Swagger (ex: approved, declined, in progress, complete, pend, error).
  • Endpoint: api/v2/boardstatus
  • Input: BoardingStatusRequestParams
  • Output: BoardingStatusResponse

Terminal IDs Request

  • Get terminal IDs and related information for your boarded application. This can be useful for partners programming their own equipment.
  • Retrieve Converge information using corresponding uniqueId, if needed.
  • Note that the Converge New Generation product (item code: CNVNG) has many hard-coded Converge setting parameters. Partners seeking automated setup of Converge accounts will need to go through an extra discussion and certification process to understand the specifics.
  • Endpoint: api/getterminalids
  • Input: getTerminalIdsRequest
  • Output: getTerminalIdsResponse

Routing Number Validation Request

  • Optional; may be made prior to boarding in order to validate a bank routing number
  • An invalid routing number will cause a boarding error
  • Endpoint: api/v2/bank
  • Input: bankingInfo
  • Output: VerifyBankAccountResponse

Postal Code Validation Request

  • Optional; can be made prior to boarding in order to validate post codes
  • Invalid postal codes will cause boarding errors
  • Values in the response results should be used to populate address fields in the boarding request; currently applicable to USA and Canada (CAN) postal codes only
  • Endpoint: api/v2/postal
  • Input: validateZipCodeRequest
  • Output: ValidateZipCodeListResponse

Get Quiz Request

  • Made prior to boarding in order to generate a Know Your Customer (KYC) quiz to have the principal of the boarding application complete
  • Currently applicable to USA and CAN only
  • Endpoint: api/v2/getquiz
  • Input: getQuizRequest
  • Output: GetQuizResponse

note

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

Answer Quiz Request

This is the final result of the quiz transaction. To represent these results in boarding, extract the fraudCheckResult block and insert it into the scarecrowApplication body of the boarding request.

  • Made prior to boarding and after a quiz has been given in order to answer that quiz
  • Currently applicable to USA and CAN only
  • Endpoint: api/v2/answerquiz
  • Input: answerQuizRequest
  • Output: AnswerQuizResponse

Upload Document Request

  • Made after boarding to upload any supporting documents to the application
  • Supported file formats: JPG, JPEG, PDF, PNG, TIF, and TIFF
  • Files must be encoded in Base64, which uses 4 characters for every 3 bytes
  • Individual files must be no more than 15 MB (15,728,640 bytes), which in Base64 is equivalent to 20 MB (20,971,520 bytes)
  • Only 5 documents can be uploaded at a time

By default, files are named SUPPORTING_DOCUMENT. In order to give your uploaded file a different name, enter a custom name in the description field.

Example:

"mimeTypeCode": "PDF",
        "imageContent": "JVBERi0xLjAKMSAwIG9iajw8L1BhZ2VzIDIgMCBSPj5lbmRvYmogMiAwIG9iajw8L0tpZHNbMyAwIFJdL0NvdW50IDE+PmVuZG9iaiAzIDAgb2JqPDwvTWVkaWFCb3hbMCAwIDMgM10+PmVuZG9iagp0cmFpbGVyPDwvUm9vdCAxIDAgUj4+Cg=="
  • Endpoint: api/v2/uploadDocuments
  • Input: uploadDocumentsRequestParams
  • Output: UploadDocumentResponse

Get Document List

You can use Elavon’s process or your own process for document generation and signing. If using your own processes, they are required to be certified by Elavon.

note

This should be the initial API called if you are NOT using Elavon’s document signing capabilities. The API returns the list of documents needed for the particular application. The output indicates which document in the list needs to be displayed and signed.

  • Endpoint: /api/listdocuments
  • Input: ListDocuments
  • Output: ListDocumentsResponse

Create Document Packet

  • Sets up the list of signers, and defines the Partner-provided URLs for both signing and timing out.
  • Returns signerUrl (this can be for multiple signers). Signer URLs are only active for 5 minutes.
  • The Partner needs to redirect their user’s browser session to the signer URL within 5 minutes. If the URL is accessed after 5 minutes, then it redirects to the Partner-provided signingExpiredURL.
  • The signer(s) have up to 20 minutes to sign before the browser session times out.
  • Once the signer signs, the session is redirected to the Partner-provided signingCompleteUrl.
  • The signer’s email address is a required field.
  • Note: The signingDeclineUrl is no longer used and can be ignored.
  • Endpoint: /api/createdocumentpacket
  • Input: CreateDocumentPacketRequest
  • Output: CreateDocumentPacketResponse

Refresh Signer User Sessions

  • Can be called to refresh the expiration time of signerUrl, provided in the Create Document Packet.
  • The signing URLs (signerUrl) are only active for 5 minutes.
  • The Partner needs to redirect their user’s browser session to the signer URL within 5 minutes. If the URL is accessed after 5 minutes, then it redirects to the Partner-provided signingExpiredURL.
  • The signer(s) have up to 20 minutes to sign before the browser session times out.
  • Once the signer signs, the session is redirected to the Partner-provided signingCompleteUrl.
  • Endpoint: /api/refreshsignerusersessions
  • Input: RefreshSignerUserSessionsRequest
  • Output: RefreshSignerUserSessionsResponse

Poll Signing Status

Polls the current status of the signers to check that each has completed signing.

  • Endpoint: /api/checkdocumentsignerstatus
  • Input: CheckDocumentSignerStatus
  • Ouput - CreateDocumentPacketResponse

Push Signing Status

Contact Elavon if you prefer to set up an endpoint and have us push the signing status to you.

Get Unsigned Documents in Packet

Returns a list of unsigned documents that require signing.

  • Endpoint: /api/getunsigneddocument
  • Input: GetUnsignedDocumentsPacketRequest
  • Output: GetDocumentResponse

Get Signed Documents in Packet

Returns a list of the signed documents.

  • Endpoint: /api/getsignedpacket
  • Input: GetsignedDocumentPacketRequest
  • Output: GetDocumentResponse

Submit Application and Documents in Packet

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

  • Endpoint: /api/v4/board
  • Input: BoardRequestParams
  • Output: BoardingResponse