void |
DefaultApi.cancelReport(UUID reportId) |
Cancel report
Cancels single paused reports.
|
okhttp3.Call |
DefaultApi.cancelReportAsync(UUID reportId,
ApiCallback<Void> _callback) |
Cancel report (asynchronously)
Cancels single paused reports.
|
okhttp3.Call |
DefaultApi.cancelReportCall(UUID reportId,
ApiCallback _callback) |
Build call for cancelReport
|
ApiResponse<Void> |
DefaultApi.cancelReportWithHttpInfo(UUID reportId) |
Cancel report
Cancels single paused reports.
|
void |
DefaultApi.completeTask(UUID workflowRunId,
String taskId,
CompleteTaskBuilder completeTaskBuilder) |
Complete Task
Completes a Send / Receive Data Task.
|
okhttp3.Call |
DefaultApi.completeTaskAsync(UUID workflowRunId,
String taskId,
CompleteTaskBuilder completeTaskBuilder,
ApiCallback<Void> _callback) |
Complete Task (asynchronously)
Completes a Send / Receive Data Task.
|
okhttp3.Call |
DefaultApi.completeTaskCall(UUID workflowRunId,
String taskId,
CompleteTaskBuilder completeTaskBuilder,
ApiCallback _callback) |
Build call for completeTask
|
ApiResponse<Void> |
DefaultApi.completeTaskWithHttpInfo(UUID workflowRunId,
String taskId,
CompleteTaskBuilder completeTaskBuilder) |
Complete Task
Completes a Send / Receive Data Task.
|
Applicant |
DefaultApi.createApplicant(ApplicantBuilder applicantBuilder) |
Create Applicant
Creates a single applicant.
|
okhttp3.Call |
DefaultApi.createApplicantAsync(ApplicantBuilder applicantBuilder,
ApiCallback<Applicant> _callback) |
Create Applicant (asynchronously)
Creates a single applicant.
|
okhttp3.Call |
DefaultApi.createApplicantCall(ApplicantBuilder applicantBuilder,
ApiCallback _callback) |
Build call for createApplicant
|
ApiResponse<Applicant> |
DefaultApi.createApplicantWithHttpInfo(ApplicantBuilder applicantBuilder) |
Create Applicant
Creates a single applicant.
|
Check |
DefaultApi.createCheck(CheckBuilder checkBuilder) |
Create a check
Initiates a check for an applicant, which can contain one or more reports.
|
okhttp3.Call |
DefaultApi.createCheckAsync(CheckBuilder checkBuilder,
ApiCallback<Check> _callback) |
Create a check (asynchronously)
Initiates a check for an applicant, which can contain one or more reports.
|
okhttp3.Call |
DefaultApi.createCheckCall(CheckBuilder checkBuilder,
ApiCallback _callback) |
Build call for createCheck
|
ApiResponse<Check> |
DefaultApi.createCheckWithHttpInfo(CheckBuilder checkBuilder) |
Create a check
Initiates a check for an applicant, which can contain one or more reports.
|
TimelineFileReference |
DefaultApi.createTimelineFile(UUID workflowRunId) |
Create Timeline File for Workflow Run
Triggers the generation of the Timeline File for the designated Workflow Run.
|
okhttp3.Call |
DefaultApi.createTimelineFileAsync(UUID workflowRunId,
ApiCallback<TimelineFileReference> _callback) |
Create Timeline File for Workflow Run (asynchronously)
Triggers the generation of the Timeline File for the designated Workflow Run.
|
okhttp3.Call |
DefaultApi.createTimelineFileCall(UUID workflowRunId,
ApiCallback _callback) |
Build call for createTimelineFile
|
ApiResponse<TimelineFileReference> |
DefaultApi.createTimelineFileWithHttpInfo(UUID workflowRunId) |
Create Timeline File for Workflow Run
Triggers the generation of the Timeline File for the designated Workflow Run.
|
WatchlistMonitor |
DefaultApi.createWatchlistMonitor(WatchlistMonitorBuilder watchlistMonitorBuilder) |
Create monitor
Creates a new monitor for the applicant
|
okhttp3.Call |
DefaultApi.createWatchlistMonitorAsync(WatchlistMonitorBuilder watchlistMonitorBuilder,
ApiCallback<WatchlistMonitor> _callback) |
Create monitor (asynchronously)
Creates a new monitor for the applicant
|
okhttp3.Call |
DefaultApi.createWatchlistMonitorCall(WatchlistMonitorBuilder watchlistMonitorBuilder,
ApiCallback _callback) |
Build call for createWatchlistMonitor
|
ApiResponse<WatchlistMonitor> |
DefaultApi.createWatchlistMonitorWithHttpInfo(WatchlistMonitorBuilder watchlistMonitorBuilder) |
Create monitor
Creates a new monitor for the applicant
|
Webhook |
DefaultApi.createWebhook(WebhookBuilder webhookBuilder) |
Register webhook
Registers a webhook.
|
okhttp3.Call |
DefaultApi.createWebhookAsync(WebhookBuilder webhookBuilder,
ApiCallback<Webhook> _callback) |
Register webhook (asynchronously)
Registers a webhook.
|
okhttp3.Call |
DefaultApi.createWebhookCall(WebhookBuilder webhookBuilder,
ApiCallback _callback) |
Build call for createWebhook
|
ApiResponse<Webhook> |
DefaultApi.createWebhookWithHttpInfo(WebhookBuilder webhookBuilder) |
Register webhook
Registers a webhook.
|
WorkflowRun |
DefaultApi.createWorkflowRun(WorkflowRunBuilder workflowRunBuilder) |
Create a Workflow Run
Creates and starts a Workflow Run.
|
okhttp3.Call |
DefaultApi.createWorkflowRunAsync(WorkflowRunBuilder workflowRunBuilder,
ApiCallback<WorkflowRun> _callback) |
Create a Workflow Run (asynchronously)
Creates and starts a Workflow Run.
|
okhttp3.Call |
DefaultApi.createWorkflowRunCall(WorkflowRunBuilder workflowRunBuilder,
ApiCallback _callback) |
Build call for createWorkflowRun
|
ApiResponse<WorkflowRun> |
DefaultApi.createWorkflowRunWithHttpInfo(WorkflowRunBuilder workflowRunBuilder) |
Create a Workflow Run
Creates and starts a Workflow Run.
|
void |
DefaultApi.deleteApplicant(UUID applicantId) |
Delete Applicant
Deletes a single applicant.
|
okhttp3.Call |
DefaultApi.deleteApplicantAsync(UUID applicantId,
ApiCallback<Void> _callback) |
Delete Applicant (asynchronously)
Deletes a single applicant.
|
okhttp3.Call |
DefaultApi.deleteApplicantCall(UUID applicantId,
ApiCallback _callback) |
Build call for deleteApplicant
|
ApiResponse<Void> |
DefaultApi.deleteApplicantWithHttpInfo(UUID applicantId) |
Delete Applicant
Deletes a single applicant.
|
void |
DefaultApi.deleteWatchlistMonitor(UUID monitorId) |
Delete monitor
Deactivates the given monitor
|
okhttp3.Call |
DefaultApi.deleteWatchlistMonitorAsync(UUID monitorId,
ApiCallback<Void> _callback) |
Delete monitor (asynchronously)
Deactivates the given monitor
|
okhttp3.Call |
DefaultApi.deleteWatchlistMonitorCall(UUID monitorId,
ApiCallback _callback) |
Build call for deleteWatchlistMonitor
|
ApiResponse<Void> |
DefaultApi.deleteWatchlistMonitorWithHttpInfo(UUID monitorId) |
Delete monitor
Deactivates the given monitor
|
void |
DefaultApi.deleteWebhook(UUID webhookId) |
Delete a webhook
Deletes a webhook.
|
okhttp3.Call |
DefaultApi.deleteWebhookAsync(UUID webhookId,
ApiCallback<Void> _callback) |
Delete a webhook (asynchronously)
Deletes a webhook.
|
okhttp3.Call |
DefaultApi.deleteWebhookCall(UUID webhookId,
ApiCallback _callback) |
Build call for deleteWebhook
|
ApiResponse<Void> |
DefaultApi.deleteWebhookWithHttpInfo(UUID webhookId) |
Delete a webhook
Deletes a webhook.
|
FileTransfer |
DefaultApi.downloadCheck(UUID checkId) |
Download check
Downloads a PDF of a check with a given check ID.
|
okhttp3.Call |
DefaultApi.downloadCheckAsync(UUID checkId,
ApiCallback<FileTransfer> _callback) |
Download check (asynchronously)
Downloads a PDF of a check with a given check ID.
|
okhttp3.Call |
DefaultApi.downloadCheckCall(UUID checkId,
ApiCallback _callback) |
Build call for downloadCheck
|
ApiResponse<FileTransfer> |
DefaultApi.downloadCheckWithHttpInfo(UUID checkId) |
Download check
Downloads a PDF of a check with a given check ID.
|
FileTransfer |
DefaultApi.downloadDocument(UUID documentId) |
Download document
Downloads specific documents belonging to an applicant.
|
okhttp3.Call |
DefaultApi.downloadDocumentAsync(UUID documentId,
ApiCallback<FileTransfer> _callback) |
Download document (asynchronously)
Downloads specific documents belonging to an applicant.
|
okhttp3.Call |
DefaultApi.downloadDocumentCall(UUID documentId,
ApiCallback _callback) |
Build call for downloadDocument
|
FileTransfer |
DefaultApi.downloadDocumentVideo(String documentId) |
Download document video
Downloads a document video.
|
okhttp3.Call |
DefaultApi.downloadDocumentVideoAsync(String documentId,
ApiCallback<FileTransfer> _callback) |
Download document video (asynchronously)
Downloads a document video.
|
okhttp3.Call |
DefaultApi.downloadDocumentVideoCall(String documentId,
ApiCallback _callback) |
Build call for downloadDocumentVideo
|
ApiResponse<FileTransfer> |
DefaultApi.downloadDocumentVideoWithHttpInfo(String documentId) |
Download document video
Downloads a document video.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadDocumentWithHttpInfo(UUID documentId) |
Download document
Downloads specific documents belonging to an applicant.
|
FileTransfer |
DefaultApi.downloadIdPhoto(UUID idPhotoId) |
Download ID photo
ID photos are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadIdPhotoAsync(UUID idPhotoId,
ApiCallback<FileTransfer> _callback) |
Download ID photo (asynchronously)
ID photos are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadIdPhotoCall(UUID idPhotoId,
ApiCallback _callback) |
Build call for downloadIdPhoto
|
ApiResponse<FileTransfer> |
DefaultApi.downloadIdPhotoWithHttpInfo(UUID idPhotoId) |
Download ID photo
ID photos are downloaded using this endpoint.
|
FileTransfer |
DefaultApi.downloadLivePhoto(UUID livePhotoId) |
Download live photo
Live photos are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadLivePhotoAsync(UUID livePhotoId,
ApiCallback<FileTransfer> _callback) |
Download live photo (asynchronously)
Live photos are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadLivePhotoCall(UUID livePhotoId,
ApiCallback _callback) |
Build call for downloadLivePhoto
|
ApiResponse<FileTransfer> |
DefaultApi.downloadLivePhotoWithHttpInfo(UUID livePhotoId) |
Download live photo
Live photos are downloaded using this endpoint.
|
FileTransfer |
DefaultApi.downloadLiveVideo(UUID liveVideoId) |
Download live video
Live videos are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadLiveVideoAsync(UUID liveVideoId,
ApiCallback<FileTransfer> _callback) |
Download live video (asynchronously)
Live videos are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadLiveVideoCall(UUID liveVideoId,
ApiCallback _callback) |
Build call for downloadLiveVideo
|
FileTransfer |
DefaultApi.downloadLiveVideoFrame(UUID liveVideoId) |
Download live video frame
Returns the binary data representing a single frame from a live video.
|
okhttp3.Call |
DefaultApi.downloadLiveVideoFrameAsync(UUID liveVideoId,
ApiCallback<FileTransfer> _callback) |
Download live video frame (asynchronously)
Returns the binary data representing a single frame from a live video.
|
okhttp3.Call |
DefaultApi.downloadLiveVideoFrameCall(UUID liveVideoId,
ApiCallback _callback) |
Build call for downloadLiveVideoFrame
|
ApiResponse<FileTransfer> |
DefaultApi.downloadLiveVideoFrameWithHttpInfo(UUID liveVideoId) |
Download live video frame
Returns the binary data representing a single frame from a live video.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadLiveVideoWithHttpInfo(UUID liveVideoId) |
Download live video
Live videos are downloaded using this endpoint.
|
FileTransfer |
DefaultApi.downloadMotionCapture(UUID motionCaptureId) |
Download motion capture
Motion captures are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadMotionCaptureAsync(UUID motionCaptureId,
ApiCallback<FileTransfer> _callback) |
Download motion capture (asynchronously)
Motion captures are downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadMotionCaptureCall(UUID motionCaptureId,
ApiCallback _callback) |
Build call for downloadMotionCapture
|
FileTransfer |
DefaultApi.downloadMotionCaptureFrame(UUID motionCaptureId) |
Download motion capture frame
Instead of the whole capture binary, a single frame can be downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadMotionCaptureFrameAsync(UUID motionCaptureId,
ApiCallback<FileTransfer> _callback) |
Download motion capture frame (asynchronously)
Instead of the whole capture binary, a single frame can be downloaded using this endpoint.
|
okhttp3.Call |
DefaultApi.downloadMotionCaptureFrameCall(UUID motionCaptureId,
ApiCallback _callback) |
Build call for downloadMotionCaptureFrame
|
ApiResponse<FileTransfer> |
DefaultApi.downloadMotionCaptureFrameWithHttpInfo(UUID motionCaptureId) |
Download motion capture frame
Instead of the whole capture binary, a single frame can be downloaded using this endpoint.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadMotionCaptureWithHttpInfo(UUID motionCaptureId) |
Download motion capture
Motion captures are downloaded using this endpoint.
|
FileTransfer |
DefaultApi.downloadQesDocument(UUID workflowRunId,
UUID fileId) |
Retrieves the signed document or application form
Retrieves the signed document or application form depending on the file_id provided.
|
okhttp3.Call |
DefaultApi.downloadQesDocumentAsync(UUID workflowRunId,
UUID fileId,
ApiCallback<FileTransfer> _callback) |
Retrieves the signed document or application form (asynchronously)
Retrieves the signed document or application form depending on the file_id provided.
|
okhttp3.Call |
DefaultApi.downloadQesDocumentCall(UUID workflowRunId,
UUID fileId,
ApiCallback _callback) |
Build call for downloadQesDocument
|
ApiResponse<FileTransfer> |
DefaultApi.downloadQesDocumentWithHttpInfo(UUID workflowRunId,
UUID fileId) |
Retrieves the signed document or application form
Retrieves the signed document or application form depending on the file_id provided.
|
FileTransfer |
DefaultApi.downloadSignedEvidenceFile(UUID workflowRunId) |
Retrieve Workflow Run Evidence Summary File
Retrieves the signed evidence file for the designated Workflow Run
|
okhttp3.Call |
DefaultApi.downloadSignedEvidenceFileAsync(UUID workflowRunId,
ApiCallback<FileTransfer> _callback) |
Retrieve Workflow Run Evidence Summary File (asynchronously)
Retrieves the signed evidence file for the designated Workflow Run
|
okhttp3.Call |
DefaultApi.downloadSignedEvidenceFileCall(UUID workflowRunId,
ApiCallback _callback) |
Build call for downloadSignedEvidenceFile
|
ApiResponse<FileTransfer> |
DefaultApi.downloadSignedEvidenceFileWithHttpInfo(UUID workflowRunId) |
Retrieve Workflow Run Evidence Summary File
Retrieves the signed evidence file for the designated Workflow Run
|
Extraction |
DefaultApi.extract(ExtractRequest extractRequest) |
Autofill
Extract information from a document
|
okhttp3.Call |
DefaultApi.extractAsync(ExtractRequest extractRequest,
ApiCallback<Extraction> _callback) |
Autofill (asynchronously)
Extract information from a document
|
okhttp3.Call |
DefaultApi.extractCall(ExtractRequest extractRequest,
ApiCallback _callback) |
Build call for extract
|
ApiResponse<Extraction> |
DefaultApi.extractWithHttpInfo(ExtractRequest extractRequest) |
Autofill
Extract information from a document
|
AddressesList |
DefaultApi.findAddresses(String postcode) |
Address Picker
Search for addresses by postcode
|
okhttp3.Call |
DefaultApi.findAddressesAsync(String postcode,
ApiCallback<AddressesList> _callback) |
Address Picker (asynchronously)
Search for addresses by postcode
|
okhttp3.Call |
DefaultApi.findAddressesCall(String postcode,
ApiCallback _callback) |
Build call for findAddresses
|
ApiResponse<AddressesList> |
DefaultApi.findAddressesWithHttpInfo(String postcode) |
Address Picker
Search for addresses by postcode
|
Applicant |
DefaultApi.findApplicant(UUID applicantId) |
Retrieve Applicant
Retrieves a single applicant.
|
okhttp3.Call |
DefaultApi.findApplicantAsync(UUID applicantId,
ApiCallback<Applicant> _callback) |
Retrieve Applicant (asynchronously)
Retrieves a single applicant.
|
okhttp3.Call |
DefaultApi.findApplicantCall(UUID applicantId,
ApiCallback _callback) |
Build call for findApplicant
|
ApiResponse<Applicant> |
DefaultApi.findApplicantWithHttpInfo(UUID applicantId) |
Retrieve Applicant
Retrieves a single applicant.
|
Check |
DefaultApi.findCheck(UUID checkId) |
Retrieve a Check
Retrieves a single check.
|
okhttp3.Call |
DefaultApi.findCheckAsync(UUID checkId,
ApiCallback<Check> _callback) |
Retrieve a Check (asynchronously)
Retrieves a single check.
|
okhttp3.Call |
DefaultApi.findCheckCall(UUID checkId,
ApiCallback _callback) |
Build call for findCheck
|
ApiResponse<Check> |
DefaultApi.findCheckWithHttpInfo(UUID checkId) |
Retrieve a Check
Retrieves a single check.
|
Document |
DefaultApi.findDocument(UUID documentId) |
Retrieve document
A single document can be retrieved by calling this endpoint with the document's unique identifier.
|
okhttp3.Call |
DefaultApi.findDocumentAsync(UUID documentId,
ApiCallback<Document> _callback) |
Retrieve document (asynchronously)
A single document can be retrieved by calling this endpoint with the document's unique identifier.
|
okhttp3.Call |
DefaultApi.findDocumentCall(UUID documentId,
ApiCallback _callback) |
Build call for findDocument
|
ApiResponse<Document> |
DefaultApi.findDocumentWithHttpInfo(UUID documentId) |
Retrieve document
A single document can be retrieved by calling this endpoint with the document's unique identifier.
|
IdPhoto |
DefaultApi.findIdPhoto(UUID idPhotoId) |
Retrieve ID photo
Retrieves a single ID photo.
|
okhttp3.Call |
DefaultApi.findIdPhotoAsync(UUID idPhotoId,
ApiCallback<IdPhoto> _callback) |
Retrieve ID photo (asynchronously)
Retrieves a single ID photo.
|
okhttp3.Call |
DefaultApi.findIdPhotoCall(UUID idPhotoId,
ApiCallback _callback) |
Build call for findIdPhoto
|
ApiResponse<IdPhoto> |
DefaultApi.findIdPhotoWithHttpInfo(UUID idPhotoId) |
Retrieve ID photo
Retrieves a single ID photo.
|
LivePhoto |
DefaultApi.findLivePhoto(UUID livePhotoId) |
Retrieve live photo
Retrieves a single live photo.
|
okhttp3.Call |
DefaultApi.findLivePhotoAsync(UUID livePhotoId,
ApiCallback<LivePhoto> _callback) |
Retrieve live photo (asynchronously)
Retrieves a single live photo.
|
okhttp3.Call |
DefaultApi.findLivePhotoCall(UUID livePhotoId,
ApiCallback _callback) |
Build call for findLivePhoto
|
ApiResponse<LivePhoto> |
DefaultApi.findLivePhotoWithHttpInfo(UUID livePhotoId) |
Retrieve live photo
Retrieves a single live photo.
|
LiveVideo |
DefaultApi.findLiveVideo(UUID liveVideoId) |
Retrieve live video
Retrieves a single live video.
|
okhttp3.Call |
DefaultApi.findLiveVideoAsync(UUID liveVideoId,
ApiCallback<LiveVideo> _callback) |
Retrieve live video (asynchronously)
Retrieves a single live video.
|
okhttp3.Call |
DefaultApi.findLiveVideoCall(UUID liveVideoId,
ApiCallback _callback) |
Build call for findLiveVideo
|
ApiResponse<LiveVideo> |
DefaultApi.findLiveVideoWithHttpInfo(UUID liveVideoId) |
Retrieve live video
Retrieves a single live video.
|
MotionCapture |
DefaultApi.findMotionCapture(UUID motionCaptureId) |
Retrieve motion capture
Retrieves a single motion capture.
|
okhttp3.Call |
DefaultApi.findMotionCaptureAsync(UUID motionCaptureId,
ApiCallback<MotionCapture> _callback) |
Retrieve motion capture (asynchronously)
Retrieves a single motion capture.
|
okhttp3.Call |
DefaultApi.findMotionCaptureCall(UUID motionCaptureId,
ApiCallback _callback) |
Build call for findMotionCapture
|
ApiResponse<MotionCapture> |
DefaultApi.findMotionCaptureWithHttpInfo(UUID motionCaptureId) |
Retrieve motion capture
Retrieves a single motion capture.
|
Report |
DefaultApi.findReport(UUID reportId) |
Retrieve report
A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
okhttp3.Call |
DefaultApi.findReportAsync(UUID reportId,
ApiCallback<Report> _callback) |
Retrieve report (asynchronously)
A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
okhttp3.Call |
DefaultApi.findReportCall(UUID reportId,
ApiCallback _callback) |
Build call for findReport
|
ApiResponse<Report> |
DefaultApi.findReportWithHttpInfo(UUID reportId) |
Retrieve report
A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
Task |
DefaultApi.findTask(UUID workflowRunId,
String taskId) |
Retrieve Task
A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
okhttp3.Call |
DefaultApi.findTaskAsync(UUID workflowRunId,
String taskId,
ApiCallback<Task> _callback) |
Retrieve Task (asynchronously)
A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
okhttp3.Call |
DefaultApi.findTaskCall(UUID workflowRunId,
String taskId,
ApiCallback _callback) |
Build call for findTask
|
ApiResponse<Task> |
DefaultApi.findTaskWithHttpInfo(UUID workflowRunId,
String taskId) |
Retrieve Task
A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
FileTransfer |
DefaultApi.findTimelineFile(UUID workflowRunId,
UUID timelineFileId) |
Retrieve Timeline File for Workflow Run
Retrieves the Timeline File for the designated Workflow Run.
|
okhttp3.Call |
DefaultApi.findTimelineFileAsync(UUID workflowRunId,
UUID timelineFileId,
ApiCallback<FileTransfer> _callback) |
Retrieve Timeline File for Workflow Run (asynchronously)
Retrieves the Timeline File for the designated Workflow Run.
|
okhttp3.Call |
DefaultApi.findTimelineFileCall(UUID workflowRunId,
UUID timelineFileId,
ApiCallback _callback) |
Build call for findTimelineFile
|
ApiResponse<FileTransfer> |
DefaultApi.findTimelineFileWithHttpInfo(UUID workflowRunId,
UUID timelineFileId) |
Retrieve Timeline File for Workflow Run
Retrieves the Timeline File for the designated Workflow Run.
|
WatchlistMonitor |
DefaultApi.findWatchlistMonitor(UUID monitorId) |
Retrieve monitor
Retrieves a single monitor
|
okhttp3.Call |
DefaultApi.findWatchlistMonitorAsync(UUID monitorId,
ApiCallback<WatchlistMonitor> _callback) |
Retrieve monitor (asynchronously)
Retrieves a single monitor
|
okhttp3.Call |
DefaultApi.findWatchlistMonitorCall(UUID monitorId,
ApiCallback _callback) |
Build call for findWatchlistMonitor
|
ApiResponse<WatchlistMonitor> |
DefaultApi.findWatchlistMonitorWithHttpInfo(UUID monitorId) |
Retrieve monitor
Retrieves a single monitor
|
Webhook |
DefaultApi.findWebhook(UUID webhookId) |
Retrieve a Webhook
Retrieves a single webhook.
|
okhttp3.Call |
DefaultApi.findWebhookAsync(UUID webhookId,
ApiCallback<Webhook> _callback) |
Retrieve a Webhook (asynchronously)
Retrieves a single webhook.
|
okhttp3.Call |
DefaultApi.findWebhookCall(UUID webhookId,
ApiCallback _callback) |
Build call for findWebhook
|
ApiResponse<Webhook> |
DefaultApi.findWebhookWithHttpInfo(UUID webhookId) |
Retrieve a Webhook
Retrieves a single webhook.
|
WorkflowRun |
DefaultApi.findWorkflowRun(UUID workflowRunId) |
Retrieve Workflow Run
A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
okhttp3.Call |
DefaultApi.findWorkflowRunAsync(UUID workflowRunId,
ApiCallback<WorkflowRun> _callback) |
Retrieve Workflow Run (asynchronously)
A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
okhttp3.Call |
DefaultApi.findWorkflowRunCall(UUID workflowRunId,
ApiCallback _callback) |
Build call for findWorkflowRun
|
ApiResponse<WorkflowRun> |
DefaultApi.findWorkflowRunWithHttpInfo(UUID workflowRunId) |
Retrieve Workflow Run
A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
void |
DefaultApi.forceReportCreationFromWatchlistMonitor(UUID monitorId) |
Force new report creation (BETA)
Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
okhttp3.Call |
DefaultApi.forceReportCreationFromWatchlistMonitorAsync(UUID monitorId,
ApiCallback<Void> _callback) |
Force new report creation (BETA) (asynchronously)
Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
okhttp3.Call |
DefaultApi.forceReportCreationFromWatchlistMonitorCall(UUID monitorId,
ApiCallback _callback) |
Build call for forceReportCreationFromWatchlistMonitor
|
ApiResponse<Void> |
DefaultApi.forceReportCreationFromWatchlistMonitorWithHttpInfo(UUID monitorId) |
Force new report creation (BETA)
Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
SdkToken |
DefaultApi.generateSdkToken(SdkTokenBuilder sdkTokenBuilder) |
Generate a SDK token
Generates an SDK token.
|
okhttp3.Call |
DefaultApi.generateSdkTokenAsync(SdkTokenBuilder sdkTokenBuilder,
ApiCallback<SdkToken> _callback) |
Generate a SDK token (asynchronously)
Generates an SDK token.
|
okhttp3.Call |
DefaultApi.generateSdkTokenCall(SdkTokenBuilder sdkTokenBuilder,
ApiCallback _callback) |
Build call for generateSdkToken
|
ApiResponse<SdkToken> |
DefaultApi.generateSdkTokenWithHttpInfo(SdkTokenBuilder sdkTokenBuilder) |
Generate a SDK token
Generates an SDK token.
|
ApplicantsList |
DefaultApi.listApplicants(Integer page,
Integer perPage,
Boolean includeDeleted) |
List Applicants
Lists all applicants you've created, sorted by creation date in descending order.
|
okhttp3.Call |
DefaultApi.listApplicantsAsync(Integer page,
Integer perPage,
Boolean includeDeleted,
ApiCallback<ApplicantsList> _callback) |
List Applicants (asynchronously)
Lists all applicants you've created, sorted by creation date in descending order.
|
okhttp3.Call |
DefaultApi.listApplicantsCall(Integer page,
Integer perPage,
Boolean includeDeleted,
ApiCallback _callback) |
Build call for listApplicants
|
ApiResponse<ApplicantsList> |
DefaultApi.listApplicantsWithHttpInfo(Integer page,
Integer perPage,
Boolean includeDeleted) |
List Applicants
Lists all applicants you've created, sorted by creation date in descending order.
|
ChecksList |
DefaultApi.listChecks(UUID applicantId) |
Retrieve Checks
Retrieves a single check.
|
okhttp3.Call |
DefaultApi.listChecksAsync(UUID applicantId,
ApiCallback<ChecksList> _callback) |
Retrieve Checks (asynchronously)
Retrieves a single check.
|
okhttp3.Call |
DefaultApi.listChecksCall(UUID applicantId,
ApiCallback _callback) |
Build call for listChecks
|
ApiResponse<ChecksList> |
DefaultApi.listChecksWithHttpInfo(UUID applicantId) |
Retrieve Checks
Retrieves a single check.
|
DocumentsList |
DefaultApi.listDocuments(UUID applicantId) |
List documents
All documents belonging to an applicant can be listed from this endpoint
|
okhttp3.Call |
DefaultApi.listDocumentsAsync(UUID applicantId,
ApiCallback<DocumentsList> _callback) |
List documents (asynchronously)
All documents belonging to an applicant can be listed from this endpoint
|
okhttp3.Call |
DefaultApi.listDocumentsCall(UUID applicantId,
ApiCallback _callback) |
Build call for listDocuments
|
ApiResponse<DocumentsList> |
DefaultApi.listDocumentsWithHttpInfo(UUID applicantId) |
List documents
All documents belonging to an applicant can be listed from this endpoint
|
IdPhotosList |
DefaultApi.listIdPhotos(UUID applicantId) |
List ID photos
Lists the ID photos that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listIdPhotosAsync(UUID applicantId,
ApiCallback<IdPhotosList> _callback) |
List ID photos (asynchronously)
Lists the ID photos that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listIdPhotosCall(UUID applicantId,
ApiCallback _callback) |
Build call for listIdPhotos
|
ApiResponse<IdPhotosList> |
DefaultApi.listIdPhotosWithHttpInfo(UUID applicantId) |
List ID photos
Lists the ID photos that belong to an applicant.
|
LivePhotosList |
DefaultApi.listLivePhotos(UUID applicantId) |
List live photos
Lists the live photos that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listLivePhotosAsync(UUID applicantId,
ApiCallback<LivePhotosList> _callback) |
List live photos (asynchronously)
Lists the live photos that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listLivePhotosCall(UUID applicantId,
ApiCallback _callback) |
Build call for listLivePhotos
|
ApiResponse<LivePhotosList> |
DefaultApi.listLivePhotosWithHttpInfo(UUID applicantId) |
List live photos
Lists the live photos that belong to an applicant.
|
LiveVideosList |
DefaultApi.listLiveVideos(UUID applicantId) |
List live videos
Lists all the live videos that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listLiveVideosAsync(UUID applicantId,
ApiCallback<LiveVideosList> _callback) |
List live videos (asynchronously)
Lists all the live videos that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listLiveVideosCall(UUID applicantId,
ApiCallback _callback) |
Build call for listLiveVideos
|
ApiResponse<LiveVideosList> |
DefaultApi.listLiveVideosWithHttpInfo(UUID applicantId) |
List live videos
Lists all the live videos that belong to an applicant.
|
MotionCapturesList |
DefaultApi.listMotionCaptures(UUID applicantId) |
List motion captures
Lists all the motion captures that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listMotionCapturesAsync(UUID applicantId,
ApiCallback<MotionCapturesList> _callback) |
List motion captures (asynchronously)
Lists all the motion captures that belong to an applicant.
|
okhttp3.Call |
DefaultApi.listMotionCapturesCall(UUID applicantId,
ApiCallback _callback) |
Build call for listMotionCaptures
|
ApiResponse<MotionCapturesList> |
DefaultApi.listMotionCapturesWithHttpInfo(UUID applicantId) |
List motion captures
Lists all the motion captures that belong to an applicant.
|
RepeatAttemptsList |
DefaultApi.listRepeatAttempts(UUID reportId) |
Retrieve repeat attempts
Returns all repeat attempts for a given Document report
|
okhttp3.Call |
DefaultApi.listRepeatAttemptsAsync(UUID reportId,
ApiCallback<RepeatAttemptsList> _callback) |
Retrieve repeat attempts (asynchronously)
Returns all repeat attempts for a given Document report
|
okhttp3.Call |
DefaultApi.listRepeatAttemptsCall(UUID reportId,
ApiCallback _callback) |
Build call for listRepeatAttempts
|
ApiResponse<RepeatAttemptsList> |
DefaultApi.listRepeatAttemptsWithHttpInfo(UUID reportId) |
Retrieve repeat attempts
Returns all repeat attempts for a given Document report
|
ReportsList |
DefaultApi.listReports(UUID checkId) |
List reports
All the reports belonging to a particular check can be listed from this endpoint.
|
okhttp3.Call |
DefaultApi.listReportsAsync(UUID checkId,
ApiCallback<ReportsList> _callback) |
List reports (asynchronously)
All the reports belonging to a particular check can be listed from this endpoint.
|
okhttp3.Call |
DefaultApi.listReportsCall(UUID checkId,
ApiCallback _callback) |
Build call for listReports
|
ApiResponse<ReportsList> |
DefaultApi.listReportsWithHttpInfo(UUID checkId) |
List reports
All the reports belonging to a particular check can be listed from this endpoint.
|
List<TaskItem> |
DefaultApi.listTasks(UUID workflowRunId) |
List Tasks
The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
okhttp3.Call |
DefaultApi.listTasksAsync(UUID workflowRunId,
ApiCallback<List<TaskItem>> _callback) |
List Tasks (asynchronously)
The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
okhttp3.Call |
DefaultApi.listTasksCall(UUID workflowRunId,
ApiCallback _callback) |
Build call for listTasks
|
ApiResponse<List<TaskItem>> |
DefaultApi.listTasksWithHttpInfo(UUID workflowRunId) |
List Tasks
The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
WatchlistMonitorMatchesList |
DefaultApi.listWatchlistMonitorMatches(UUID monitorId) |
List matches (BETA)
List match IDs on this monitor, as well as their enabled/disabled status
|
okhttp3.Call |
DefaultApi.listWatchlistMonitorMatchesAsync(UUID monitorId,
ApiCallback<WatchlistMonitorMatchesList> _callback) |
List matches (BETA) (asynchronously)
List match IDs on this monitor, as well as their enabled/disabled status
|
okhttp3.Call |
DefaultApi.listWatchlistMonitorMatchesCall(UUID monitorId,
ApiCallback _callback) |
Build call for listWatchlistMonitorMatches
|
ApiResponse<WatchlistMonitorMatchesList> |
DefaultApi.listWatchlistMonitorMatchesWithHttpInfo(UUID monitorId) |
List matches (BETA)
List match IDs on this monitor, as well as their enabled/disabled status
|
WatchlistMonitorsList |
DefaultApi.listWatchlistMonitors(UUID applicantId,
Boolean includeDeleted) |
List monitors
List all available monitors for an applicant
|
okhttp3.Call |
DefaultApi.listWatchlistMonitorsAsync(UUID applicantId,
Boolean includeDeleted,
ApiCallback<WatchlistMonitorsList> _callback) |
List monitors (asynchronously)
List all available monitors for an applicant
|
okhttp3.Call |
DefaultApi.listWatchlistMonitorsCall(UUID applicantId,
Boolean includeDeleted,
ApiCallback _callback) |
Build call for listWatchlistMonitors
|
ApiResponse<WatchlistMonitorsList> |
DefaultApi.listWatchlistMonitorsWithHttpInfo(UUID applicantId,
Boolean includeDeleted) |
List monitors
List all available monitors for an applicant
|
WebhooksList |
DefaultApi.listWebhooks() |
List webhooks
Lists all webhooks you've created.
|
okhttp3.Call |
DefaultApi.listWebhooksAsync(ApiCallback<WebhooksList> _callback) |
List webhooks (asynchronously)
Lists all webhooks you've created.
|
okhttp3.Call |
DefaultApi.listWebhooksCall(ApiCallback _callback) |
Build call for listWebhooks
|
ApiResponse<WebhooksList> |
DefaultApi.listWebhooksWithHttpInfo() |
List webhooks
Lists all webhooks you've created.
|
List<WorkflowRun> |
DefaultApi.listWorkflowRuns(Integer page,
String status,
OffsetDateTime createdAtGt,
OffsetDateTime createdAtLt,
String sort) |
List Workflow Runs
Retrieves the Workflow Runs of the client.
|
okhttp3.Call |
DefaultApi.listWorkflowRunsAsync(Integer page,
String status,
OffsetDateTime createdAtGt,
OffsetDateTime createdAtLt,
String sort,
ApiCallback<List<WorkflowRun>> _callback) |
List Workflow Runs (asynchronously)
Retrieves the Workflow Runs of the client.
|
okhttp3.Call |
DefaultApi.listWorkflowRunsCall(Integer page,
String status,
OffsetDateTime createdAtGt,
OffsetDateTime createdAtLt,
String sort,
ApiCallback _callback) |
Build call for listWorkflowRuns
|
ApiResponse<List<WorkflowRun>> |
DefaultApi.listWorkflowRunsWithHttpInfo(Integer page,
String status,
OffsetDateTime createdAtGt,
OffsetDateTime createdAtLt,
String sort) |
List Workflow Runs
Retrieves the Workflow Runs of the client.
|
String |
DefaultApi.ping() |
Ping
Run a health check on the Onfido API
|
okhttp3.Call |
DefaultApi.pingAsync(ApiCallback<String> _callback) |
Ping (asynchronously)
Run a health check on the Onfido API
|
okhttp3.Call |
DefaultApi.pingCall(ApiCallback _callback) |
Build call for ping
|
ApiResponse<String> |
DefaultApi.pingWithHttpInfo() |
Ping
Run a health check on the Onfido API
|
ResultsFeedback |
DefaultApi.postResultsFeedback(ResultsFeedback resultsFeedback) |
Fraud reporting (ALPHA)
Create Feedback on checks and reports
|
okhttp3.Call |
DefaultApi.postResultsFeedbackAsync(ResultsFeedback resultsFeedback,
ApiCallback<ResultsFeedback> _callback) |
Fraud reporting (ALPHA) (asynchronously)
Create Feedback on checks and reports
|
okhttp3.Call |
DefaultApi.postResultsFeedbackCall(ResultsFeedback resultsFeedback,
ApiCallback _callback) |
Build call for postResultsFeedback
|
ApiResponse<ResultsFeedback> |
DefaultApi.postResultsFeedbackWithHttpInfo(ResultsFeedback resultsFeedback) |
Fraud reporting (ALPHA)
Create Feedback on checks and reports
|
void |
DefaultApi.resendWebhooks(WebhookResend webhookResend) |
Resends webhooks
Resends events to all webhooks registered with a matching environment in your account.
|
okhttp3.Call |
DefaultApi.resendWebhooksAsync(WebhookResend webhookResend,
ApiCallback<Void> _callback) |
Resends webhooks (asynchronously)
Resends events to all webhooks registered with a matching environment in your account.
|
okhttp3.Call |
DefaultApi.resendWebhooksCall(WebhookResend webhookResend,
ApiCallback _callback) |
Build call for resendWebhooks
|
ApiResponse<Void> |
DefaultApi.resendWebhooksWithHttpInfo(WebhookResend webhookResend) |
Resends webhooks
Resends events to all webhooks registered with a matching environment in your account.
|
void |
DefaultApi.restoreApplicant(UUID applicantId) |
Restore Applicant
Restores a single applicant scheduled for deletion.
|
okhttp3.Call |
DefaultApi.restoreApplicantAsync(UUID applicantId,
ApiCallback<Void> _callback) |
Restore Applicant (asynchronously)
Restores a single applicant scheduled for deletion.
|
okhttp3.Call |
DefaultApi.restoreApplicantCall(UUID applicantId,
ApiCallback _callback) |
Build call for restoreApplicant
|
ApiResponse<Void> |
DefaultApi.restoreApplicantWithHttpInfo(UUID applicantId) |
Restore Applicant
Restores a single applicant scheduled for deletion.
|
void |
DefaultApi.resumeCheck(UUID checkId) |
Resume a Check
Resumes a paused check.
|
okhttp3.Call |
DefaultApi.resumeCheckAsync(UUID checkId,
ApiCallback<Void> _callback) |
Resume a Check (asynchronously)
Resumes a paused check.
|
okhttp3.Call |
DefaultApi.resumeCheckCall(UUID checkId,
ApiCallback _callback) |
Build call for resumeCheck
|
ApiResponse<Void> |
DefaultApi.resumeCheckWithHttpInfo(UUID checkId) |
Resume a Check
Resumes a paused check.
|
void |
DefaultApi.resumeReport(UUID reportId) |
Resume report
Resumes a single paused report.
|
okhttp3.Call |
DefaultApi.resumeReportAsync(UUID reportId,
ApiCallback<Void> _callback) |
Resume report (asynchronously)
Resumes a single paused report.
|
okhttp3.Call |
DefaultApi.resumeReportCall(UUID reportId,
ApiCallback _callback) |
Build call for resumeReport
|
ApiResponse<Void> |
DefaultApi.resumeReportWithHttpInfo(UUID reportId) |
Resume report
Resumes a single paused report.
|
Applicant |
DefaultApi.updateApplicant(UUID applicantId,
ApplicantUpdater applicantUpdater) |
Update Applicant
Allows updating applicant's information before any checks is created.
|
okhttp3.Call |
DefaultApi.updateApplicantAsync(UUID applicantId,
ApplicantUpdater applicantUpdater,
ApiCallback<Applicant> _callback) |
Update Applicant (asynchronously)
Allows updating applicant's information before any checks is created.
|
okhttp3.Call |
DefaultApi.updateApplicantCall(UUID applicantId,
ApplicantUpdater applicantUpdater,
ApiCallback _callback) |
Build call for updateApplicant
|
ApiResponse<Applicant> |
DefaultApi.updateApplicantWithHttpInfo(UUID applicantId,
ApplicantUpdater applicantUpdater) |
Update Applicant
Allows updating applicant's information before any checks is created.
|
WatchlistMonitorMatchesList |
DefaultApi.updateWatchlistMonitorMatch(UUID monitorId,
WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater) |
Set match status (BETA)
Update the status of the given matches
|
okhttp3.Call |
DefaultApi.updateWatchlistMonitorMatchAsync(UUID monitorId,
WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater,
ApiCallback<WatchlistMonitorMatchesList> _callback) |
Set match status (BETA) (asynchronously)
Update the status of the given matches
|
okhttp3.Call |
DefaultApi.updateWatchlistMonitorMatchCall(UUID monitorId,
WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater,
ApiCallback _callback) |
Build call for updateWatchlistMonitorMatch
|
ApiResponse<WatchlistMonitorMatchesList> |
DefaultApi.updateWatchlistMonitorMatchWithHttpInfo(UUID monitorId,
WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater) |
Set match status (BETA)
Update the status of the given matches
|
Webhook |
DefaultApi.updateWebhook(UUID webhookId,
WebhookUpdater webhookUpdater) |
Edit a webhook
Edits a webhook.
|
okhttp3.Call |
DefaultApi.updateWebhookAsync(UUID webhookId,
WebhookUpdater webhookUpdater,
ApiCallback<Webhook> _callback) |
Edit a webhook (asynchronously)
Edits a webhook.
|
okhttp3.Call |
DefaultApi.updateWebhookCall(UUID webhookId,
WebhookUpdater webhookUpdater,
ApiCallback _callback) |
Build call for updateWebhook
|
ApiResponse<Webhook> |
DefaultApi.updateWebhookWithHttpInfo(UUID webhookId,
WebhookUpdater webhookUpdater) |
Edit a webhook
Edits a webhook.
|
Document |
DefaultApi.uploadDocument(DocumentTypes type,
UUID applicantId,
FileTransfer _file,
String fileType,
String side,
CountryCodes issuingCountry,
Boolean validateImageQuality,
LocationBuilder location) |
Upload a document
Documents are uploaded using this endpoint.
|
okhttp3.Call |
DefaultApi.uploadDocumentAsync(DocumentTypes type,
UUID applicantId,
FileTransfer _file,
String fileType,
String side,
CountryCodes issuingCountry,
Boolean validateImageQuality,
LocationBuilder location,
ApiCallback<Document> _callback) |
Upload a document (asynchronously)
Documents are uploaded using this endpoint.
|
okhttp3.Call |
DefaultApi.uploadDocumentCall(DocumentTypes type,
UUID applicantId,
FileTransfer _file,
String fileType,
String side,
CountryCodes issuingCountry,
Boolean validateImageQuality,
LocationBuilder location,
ApiCallback _callback) |
Build call for uploadDocument
|
ApiResponse<Document> |
DefaultApi.uploadDocumentWithHttpInfo(DocumentTypes type,
UUID applicantId,
FileTransfer _file,
String fileType,
String side,
CountryCodes issuingCountry,
Boolean validateImageQuality,
LocationBuilder location) |
Upload a document
Documents are uploaded using this endpoint.
|
IdPhoto |
DefaultApi.uploadIdPhoto(UUID applicantId,
FileTransfer _file) |
Upload ID photo
You can upload ID photos to this endpoint.
|
okhttp3.Call |
DefaultApi.uploadIdPhotoAsync(UUID applicantId,
FileTransfer _file,
ApiCallback<IdPhoto> _callback) |
Upload ID photo (asynchronously)
You can upload ID photos to this endpoint.
|
okhttp3.Call |
DefaultApi.uploadIdPhotoCall(UUID applicantId,
FileTransfer _file,
ApiCallback _callback) |
Build call for uploadIdPhoto
|
ApiResponse<IdPhoto> |
DefaultApi.uploadIdPhotoWithHttpInfo(UUID applicantId,
FileTransfer _file) |
Upload ID photo
You can upload ID photos to this endpoint.
|
LivePhoto |
DefaultApi.uploadLivePhoto(UUID applicantId,
FileTransfer _file,
Boolean advancedValidation) |
Upload live photo
You can upload live photos to this endpoint.
|
okhttp3.Call |
DefaultApi.uploadLivePhotoAsync(UUID applicantId,
FileTransfer _file,
Boolean advancedValidation,
ApiCallback<LivePhoto> _callback) |
Upload live photo (asynchronously)
You can upload live photos to this endpoint.
|
okhttp3.Call |
DefaultApi.uploadLivePhotoCall(UUID applicantId,
FileTransfer _file,
Boolean advancedValidation,
ApiCallback _callback) |
Build call for uploadLivePhoto
|
ApiResponse<LivePhoto> |
DefaultApi.uploadLivePhotoWithHttpInfo(UUID applicantId,
FileTransfer _file,
Boolean advancedValidation) |
Upload live photo
You can upload live photos to this endpoint.
|