Documents API Calls Diagram
This sequence diagram depicts documents-based calls to the eBoarding API.
It is important to make documents calls in the proper order.
- Start with the
ListDocumentsAPI call. This will return a list of required documents.
- Then send a
CreateDocumentPacketRequest. This will return the
documentPacketIdand a list of signer IDs along with their corresponding signer URLs.
- Next send a
GetUnsignedDocumentsPacketRequest. This returns a list of unsigned documents. Repeat this step as necessary.
- Then send a
RefreshSignerUserSessionsRequest. This returns a list of signer IDs and signer URLs. Repeat this step as necessary.
- After the above API operations have been executed, you can start checking to see if all required signers have signed the documentation by using
CheckDocumentSignerStatus. This returns the document packet's status and a list of signers' statuses (DRAFT, ACCEPTED, SIGNED, DECLINED, or EXPIRED).
- Now use
GetSignedDocumentPacketRequest, which returns a list of signed documents.
- At this point, you can
Boardthe application with the
documentPacketId. This will return a boarding response (AWB for North America, MID for Europe, or an error).
- Finally, you can use
BoardStatusto check your application's boarding response (COMPLETE, INPROGRESS, DECLINED, WITHDRAWN, ERROR, TIMED_OUT, or PEND).