Handling orders

This chapter covers the full lifecycle of an order: creating it, checking its progress, retrieving the resulting data in various formats, and cleaning up afterwards.

Order lifecycle

• Creating Orders — putOrder creates a new identification and/or eSign order. Covers required and optional request fields, product/behavior flags, and the response containing the OrderID and the URL to redirect the user to.
• Checking the status of orders — getStatus reports the current status codes of an order, including the distinction between normal/extended and final/non-final codes, and the full list of status and sub-status codes.

Retrieving results

• Retrieving identification results in JSON format — getIdentData returns the checked/initial identification data for a finally processed order.
• Retrieving identification results as a PDF — getIdentDataPDF returns the same data as a PDF document, including images by default.
• Retrieving signed documents — getESignPDF returns the processed/signed eSign PDF document(s) for an order.
• Retrieving signing hashes — getESignHash returns the hashes of the processed/signed documents instead of the full PDFs.
• Retrieving AES audit log file — getESignAuditLogPDF returns the audit log for AES (Advanced Electronic Signature) orders.
• Retrieving recorded images — getImages returns the images recorded during identification separately from the rest of the identification data.
• Retrieving video binary files after provision — getVideoFileBinary returns the recorded video of a video identification session.
• Retrieving audio binary files — getVoiceFiles returns the audio recording used in countries where an audio-only identification is sufficient.

Cleanup and lookup

• Working with incomplete Orders — covers timeouts for incomplete orders and cancelOrder to stop an open order from being processed.
• Deleting identification data — delIdentdata removes the stored result data of a finally processed order.
• Retrieving OrderIDs for given Ref — getOrdersByRef looks up the OrderID(s) matching your internal Ref from the last 90 days.