java.lang.Object
- com.onfido.api.DefaultApi

```
public class DefaultApi
extends Object
```

Constructor Summary

Constructors
Constructor Description

DefaultApi()

DefaultApi(ApiClient apiClient)

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultApi
```
public DefaultApi()
```

DefaultApi

public DefaultApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex
```
public int getHostIndex()
```

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl
```
public String getCustomBaseUrl()
```

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

cancelReportCall
```
public okhttp3.Call cancelReportCall(UUID reportId,
                                     ApiCallback _callback)
                              throws ApiException
```
Build call for cancelReport

Parameters:

reportId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

cancelReport
```
public void cancelReport(UUID reportId)
                  throws ApiException
```
Cancel report Cancels single paused reports.

Parameters:

reportId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

cancelReportWithHttpInfo
```
public ApiResponse<Void> cancelReportWithHttpInfo(UUID reportId)
                                           throws ApiException
```
Cancel report Cancels single paused reports.

Parameters:

reportId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

cancelReportAsync
```
public okhttp3.Call cancelReportAsync(UUID reportId,
                                      ApiCallback<Void> _callback)
                               throws ApiException
```
Cancel report (asynchronously) Cancels single paused reports.

Parameters:

reportId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

completeTaskCall
```
public okhttp3.Call completeTaskCall(UUID workflowRunId,
                                     String taskId,
                                     CompleteTaskBuilder completeTaskBuilder,
                                     ApiCallback _callback)
                              throws ApiException
```
Build call for completeTask

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to complete. (required)

completeTaskBuilder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An empty response body. -

0 Unexpected error -

completeTask
```
public void completeTask(UUID workflowRunId,
                         String taskId,
                         CompleteTaskBuilder completeTaskBuilder)
                  throws ApiException
```
Complete Task Completes a Send / Receive Data Task.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to complete. (required)

completeTaskBuilder - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An empty response body. -

0 Unexpected error -

completeTaskWithHttpInfo
```
public ApiResponse<Void> completeTaskWithHttpInfo(UUID workflowRunId,
                                                  String taskId,
                                                  CompleteTaskBuilder completeTaskBuilder)
                                           throws ApiException
```
Complete Task Completes a Send / Receive Data Task.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to complete. (required)

completeTaskBuilder - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An empty response body. -

0 Unexpected error -

completeTaskAsync
```
public okhttp3.Call completeTaskAsync(UUID workflowRunId,
                                      String taskId,
                                      CompleteTaskBuilder completeTaskBuilder,
                                      ApiCallback<Void> _callback)
                               throws ApiException
```
Complete Task (asynchronously) Completes a Send / Receive Data Task.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to complete. (required)

completeTaskBuilder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An empty response body. -

0 Unexpected error -

createApplicantCall
```
public okhttp3.Call createApplicantCall(ApplicantBuilder applicantBuilder,
                                        ApiCallback _callback)
                                 throws ApiException
```
Build call for createApplicant

Parameters:

applicantBuilder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createApplicant
```
public Applicant createApplicant(ApplicantBuilder applicantBuilder)
                          throws ApiException
```
Create Applicant Creates a single applicant. Returns an applicant object.

Parameters:

applicantBuilder - (required)

Returns:

Applicant

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createApplicantWithHttpInfo
```
public ApiResponse<Applicant> createApplicantWithHttpInfo(ApplicantBuilder applicantBuilder)
                                                   throws ApiException
```
Create Applicant Creates a single applicant. Returns an applicant object.

Parameters:

applicantBuilder - (required)

Returns:

ApiResponse<Applicant>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createApplicantAsync
```
public okhttp3.Call createApplicantAsync(ApplicantBuilder applicantBuilder,
                                         ApiCallback<Applicant> _callback)
                                  throws ApiException
```
Create Applicant (asynchronously) Creates a single applicant. Returns an applicant object.

Parameters:

applicantBuilder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createCheckCall
```
public okhttp3.Call createCheckCall(CheckBuilder checkBuilder,
                                    ApiCallback _callback)
                             throws ApiException
```
Build call for createCheck

Parameters:

checkBuilder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createCheck
```
public Check createCheck(CheckBuilder checkBuilder)
                  throws ApiException
```
Create a check Initiates a check for an applicant, which can contain one or more reports. Returns a check object.

Parameters:

checkBuilder - (required)

Returns:

Check

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createCheckWithHttpInfo
```
public ApiResponse<Check> createCheckWithHttpInfo(CheckBuilder checkBuilder)
                                           throws ApiException
```
Create a check Initiates a check for an applicant, which can contain one or more reports. Returns a check object.

Parameters:

checkBuilder - (required)

Returns:

ApiResponse<Check>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createCheckAsync
```
public okhttp3.Call createCheckAsync(CheckBuilder checkBuilder,
                                     ApiCallback<Check> _callback)
                              throws ApiException
```
Create a check (asynchronously) Initiates a check for an applicant, which can contain one or more reports. Returns a check object.

Parameters:

checkBuilder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createTimelineFileCall
```
public okhttp3.Call createTimelineFileCall(UUID workflowRunId,
                                           ApiCallback _callback)
                                    throws ApiException
```
Build call for createTimelineFile

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

202 A Timeline File reference. -

0 Unexpected error -

createTimelineFile
```
public TimelineFileReference createTimelineFile(UUID workflowRunId)
                                         throws ApiException
```
Create Timeline File for Workflow Run Triggers the generation of the Timeline File for the designated Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

Returns:

TimelineFileReference

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

202 A Timeline File reference. -

0 Unexpected error -

createTimelineFileWithHttpInfo
```
public ApiResponse<TimelineFileReference> createTimelineFileWithHttpInfo(UUID workflowRunId)
                                                                  throws ApiException
```
Create Timeline File for Workflow Run Triggers the generation of the Timeline File for the designated Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

Returns:

ApiResponse<TimelineFileReference>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

202 A Timeline File reference. -

0 Unexpected error -

createTimelineFileAsync
```
public okhttp3.Call createTimelineFileAsync(UUID workflowRunId,
                                            ApiCallback<TimelineFileReference> _callback)
                                     throws ApiException
```
Create Timeline File for Workflow Run (asynchronously) Triggers the generation of the Timeline File for the designated Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

202 A Timeline File reference. -

0 Unexpected error -

createWatchlistMonitorCall
```
public okhttp3.Call createWatchlistMonitorCall(WatchlistMonitorBuilder watchlistMonitorBuilder,
                                               ApiCallback _callback)
                                        throws ApiException
```
Build call for createWatchlistMonitor

Parameters:

watchlistMonitorBuilder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWatchlistMonitor
```
public WatchlistMonitor createWatchlistMonitor(WatchlistMonitorBuilder watchlistMonitorBuilder)
                                        throws ApiException
```
Create monitor Creates a new monitor for the applicant

Parameters:

watchlistMonitorBuilder - (required)

Returns:

WatchlistMonitor

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWatchlistMonitorWithHttpInfo
```
public ApiResponse<WatchlistMonitor> createWatchlistMonitorWithHttpInfo(WatchlistMonitorBuilder watchlistMonitorBuilder)
                                                                 throws ApiException
```
Create monitor Creates a new monitor for the applicant

Parameters:

watchlistMonitorBuilder - (required)

Returns:

ApiResponse<WatchlistMonitor>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWatchlistMonitorAsync
```
public okhttp3.Call createWatchlistMonitorAsync(WatchlistMonitorBuilder watchlistMonitorBuilder,
                                                ApiCallback<WatchlistMonitor> _callback)
                                         throws ApiException
```
Create monitor (asynchronously) Creates a new monitor for the applicant

Parameters:

watchlistMonitorBuilder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWebhookCall
```
public okhttp3.Call createWebhookCall(WebhookBuilder webhookBuilder,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for createWebhook

Parameters:

webhookBuilder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWebhook
```
public Webhook createWebhook(WebhookBuilder webhookBuilder)
                      throws ApiException
```
Register webhook Registers a webhook. Returns a webhook object.

Parameters:

webhookBuilder - (required)

Returns:

Webhook

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWebhookWithHttpInfo
```
public ApiResponse<Webhook> createWebhookWithHttpInfo(WebhookBuilder webhookBuilder)
                                               throws ApiException
```
Register webhook Registers a webhook. Returns a webhook object.

Parameters:

webhookBuilder - (required)

Returns:

ApiResponse<Webhook>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWebhookAsync
```
public okhttp3.Call createWebhookAsync(WebhookBuilder webhookBuilder,
                                       ApiCallback<Webhook> _callback)
                                throws ApiException
```
Register webhook (asynchronously) Registers a webhook. Returns a webhook object.

Parameters:

webhookBuilder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 Created -

0 Unexpected error -

createWorkflowRunCall
```
public okhttp3.Call createWorkflowRunCall(WorkflowRunBuilder workflowRunBuilder,
                                          ApiCallback _callback)
                                   throws ApiException
```
Build call for createWorkflowRun

Parameters:

workflowRunBuilder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 A Workflow Run object. -

0 Unexpected error -

createWorkflowRun
```
public WorkflowRun createWorkflowRun(WorkflowRunBuilder workflowRunBuilder)
                              throws ApiException
```
Create a Workflow Run Creates and starts a Workflow Run. Returns a Workflow Run object.

Parameters:

workflowRunBuilder - (required)

Returns:

WorkflowRun

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 A Workflow Run object. -

0 Unexpected error -

createWorkflowRunWithHttpInfo
```
public ApiResponse<WorkflowRun> createWorkflowRunWithHttpInfo(WorkflowRunBuilder workflowRunBuilder)
                                                       throws ApiException
```
Create a Workflow Run Creates and starts a Workflow Run. Returns a Workflow Run object.

Parameters:

workflowRunBuilder - (required)

Returns:

ApiResponse<WorkflowRun>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 A Workflow Run object. -

0 Unexpected error -

createWorkflowRunAsync
```
public okhttp3.Call createWorkflowRunAsync(WorkflowRunBuilder workflowRunBuilder,
                                           ApiCallback<WorkflowRun> _callback)
                                    throws ApiException
```
Create a Workflow Run (asynchronously) Creates and starts a Workflow Run. Returns a Workflow Run object.

Parameters:

workflowRunBuilder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 A Workflow Run object. -

0 Unexpected error -

deleteApplicantCall
```
public okhttp3.Call deleteApplicantCall(UUID applicantId,
                                        ApiCallback _callback)
                                 throws ApiException
```
Build call for deleteApplicant

Parameters:

applicantId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteApplicant
```
public void deleteApplicant(UUID applicantId)
                     throws ApiException
```
Delete Applicant Deletes a single applicant.

Parameters:

applicantId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteApplicantWithHttpInfo
```
public ApiResponse<Void> deleteApplicantWithHttpInfo(UUID applicantId)
                                              throws ApiException
```
Delete Applicant Deletes a single applicant.

Parameters:

applicantId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteApplicantAsync
```
public okhttp3.Call deleteApplicantAsync(UUID applicantId,
                                         ApiCallback<Void> _callback)
                                  throws ApiException
```
Delete Applicant (asynchronously) Deletes a single applicant.

Parameters:

applicantId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteWatchlistMonitorCall
```
public okhttp3.Call deleteWatchlistMonitorCall(UUID monitorId,
                                               ApiCallback _callback)
                                        throws ApiException
```
Build call for deleteWatchlistMonitor

Parameters:

monitorId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteWatchlistMonitor
```
public void deleteWatchlistMonitor(UUID monitorId)
                            throws ApiException
```
Delete monitor Deactivates the given monitor

Parameters:

monitorId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteWatchlistMonitorWithHttpInfo
```
public ApiResponse<Void> deleteWatchlistMonitorWithHttpInfo(UUID monitorId)
                                                     throws ApiException
```
Delete monitor Deactivates the given monitor

Parameters:

monitorId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteWatchlistMonitorAsync
```
public okhttp3.Call deleteWatchlistMonitorAsync(UUID monitorId,
                                                ApiCallback<Void> _callback)
                                         throws ApiException
```
Delete monitor (asynchronously) Deactivates the given monitor

Parameters:

monitorId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

deleteWebhookCall
```
public okhttp3.Call deleteWebhookCall(UUID webhookId,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for deleteWebhook

Parameters:

webhookId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

204 Webhook deleted -

0 Unexpected error -

deleteWebhook
```
public void deleteWebhook(UUID webhookId)
                   throws ApiException
```
Delete a webhook Deletes a webhook.

Parameters:

webhookId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 Webhook deleted -

0 Unexpected error -

deleteWebhookWithHttpInfo
```
public ApiResponse<Void> deleteWebhookWithHttpInfo(UUID webhookId)
                                            throws ApiException
```
Delete a webhook Deletes a webhook.

Parameters:

webhookId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 Webhook deleted -

0 Unexpected error -

deleteWebhookAsync
```
public okhttp3.Call deleteWebhookAsync(UUID webhookId,
                                       ApiCallback<Void> _callback)
                                throws ApiException
```
Delete a webhook (asynchronously) Deletes a webhook.

Parameters:

webhookId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

204 Webhook deleted -

0 Unexpected error -

downloadCheckCall
```
public okhttp3.Call downloadCheckCall(UUID checkId,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for downloadCheck

Parameters:

checkId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The check PDF binary data -

0 Unexpected error -

downloadCheck
```
public FileTransfer downloadCheck(UUID checkId)
                           throws ApiException
```
Download check Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.

Parameters:

checkId - (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The check PDF binary data -

0 Unexpected error -

downloadCheckWithHttpInfo
```
public ApiResponse<FileTransfer> downloadCheckWithHttpInfo(UUID checkId)
                                                    throws ApiException
```
Download check Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.

Parameters:

checkId - (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The check PDF binary data -

0 Unexpected error -

downloadCheckAsync
```
public okhttp3.Call downloadCheckAsync(UUID checkId,
                                       ApiCallback<FileTransfer> _callback)
                                throws ApiException
```
Download check (asynchronously) Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.

Parameters:

checkId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The check PDF binary data -

0 Unexpected error -

downloadDocumentCall
```
public okhttp3.Call downloadDocumentCall(UUID documentId,
                                         ApiCallback _callback)
                                  throws ApiException
```
Build call for downloadDocument

Parameters:

documentId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The document binary data -

0 Unexpected error -

downloadDocument
```
public FileTransfer downloadDocument(UUID documentId)
                              throws ApiException
```
Download document Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.

Parameters:

documentId - (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The document binary data -

0 Unexpected error -

downloadDocumentWithHttpInfo
```
public ApiResponse<FileTransfer> downloadDocumentWithHttpInfo(UUID documentId)
                                                       throws ApiException
```
Download document Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.

Parameters:

documentId - (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The document binary data -

0 Unexpected error -

downloadDocumentAsync
```
public okhttp3.Call downloadDocumentAsync(UUID documentId,
                                          ApiCallback<FileTransfer> _callback)
                                   throws ApiException
```
Download document (asynchronously) Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.

Parameters:

documentId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The document binary data -

0 Unexpected error -

downloadDocumentVideoCall
```
public okhttp3.Call downloadDocumentVideoCall(String documentId,
                                              ApiCallback _callback)
                                       throws ApiException
```
Build call for downloadDocumentVideo

Parameters:

documentId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The document's video binary data -

0 Unexpected error -

downloadDocumentVideo
```
public FileTransfer downloadDocumentVideo(String documentId)
                                   throws ApiException
```
Download document video Downloads a document video. If successful, the response will be the binary data representing the video.

Parameters:

documentId - (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The document's video binary data -

0 Unexpected error -

downloadDocumentVideoWithHttpInfo
```
public ApiResponse<FileTransfer> downloadDocumentVideoWithHttpInfo(String documentId)
                                                            throws ApiException
```
Download document video Downloads a document video. If successful, the response will be the binary data representing the video.

Parameters:

documentId - (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The document's video binary data -

0 Unexpected error -

downloadDocumentVideoAsync
```
public okhttp3.Call downloadDocumentVideoAsync(String documentId,
                                               ApiCallback<FileTransfer> _callback)
                                        throws ApiException
```
Download document video (asynchronously) Downloads a document video. If successful, the response will be the binary data representing the video.

Parameters:

documentId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The document's video binary data -

0 Unexpected error -

downloadIdPhotoCall
```
public okhttp3.Call downloadIdPhotoCall(UUID idPhotoId,
                                        ApiCallback _callback)
                                 throws ApiException
```
Build call for downloadIdPhoto

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The ID photo's binary data. -

0 Unexpected error -

downloadIdPhoto
```
public FileTransfer downloadIdPhoto(UUID idPhotoId)
                             throws ApiException
```
Download ID photo ID photos are downloaded using this endpoint.

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The ID photo's binary data. -

0 Unexpected error -

downloadIdPhotoWithHttpInfo
```
public ApiResponse<FileTransfer> downloadIdPhotoWithHttpInfo(UUID idPhotoId)
                                                      throws ApiException
```
Download ID photo ID photos are downloaded using this endpoint.

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The ID photo's binary data. -

0 Unexpected error -

downloadIdPhotoAsync
```
public okhttp3.Call downloadIdPhotoAsync(UUID idPhotoId,
                                         ApiCallback<FileTransfer> _callback)
                                  throws ApiException
```
Download ID photo (asynchronously) ID photos are downloaded using this endpoint.

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The ID photo's binary data. -

0 Unexpected error -

downloadLivePhotoCall
```
public okhttp3.Call downloadLivePhotoCall(UUID livePhotoId,
                                          ApiCallback _callback)
                                   throws ApiException
```
Build call for downloadLivePhoto

Parameters:

livePhotoId - The live photo's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The live photo's binary data. -

0 Unexpected error -

downloadLivePhoto
```
public FileTransfer downloadLivePhoto(UUID livePhotoId)
                               throws ApiException
```
Download live photo Live photos are downloaded using this endpoint.

Parameters:

livePhotoId - The live photo's unique identifier. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The live photo's binary data. -

0 Unexpected error -

downloadLivePhotoWithHttpInfo
```
public ApiResponse<FileTransfer> downloadLivePhotoWithHttpInfo(UUID livePhotoId)
                                                        throws ApiException
```
Download live photo Live photos are downloaded using this endpoint.

Parameters:

livePhotoId - The live photo's unique identifier. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The live photo's binary data. -

0 Unexpected error -

downloadLivePhotoAsync
```
public okhttp3.Call downloadLivePhotoAsync(UUID livePhotoId,
                                           ApiCallback<FileTransfer> _callback)
                                    throws ApiException
```
Download live photo (asynchronously) Live photos are downloaded using this endpoint.

Parameters:

livePhotoId - The live photo's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The live photo's binary data. -

0 Unexpected error -

downloadLiveVideoCall
```
public okhttp3.Call downloadLiveVideoCall(UUID liveVideoId,
                                          ApiCallback _callback)
                                   throws ApiException
```
Build call for downloadLiveVideo

Parameters:

liveVideoId - The live video's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The live video's binary data. -

0 Unexpected error -

downloadLiveVideo
```
public FileTransfer downloadLiveVideo(UUID liveVideoId)
                               throws ApiException
```
Download live video Live videos are downloaded using this endpoint.

Parameters:

liveVideoId - The live video's unique identifier. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The live video's binary data. -

0 Unexpected error -

downloadLiveVideoWithHttpInfo
```
public ApiResponse<FileTransfer> downloadLiveVideoWithHttpInfo(UUID liveVideoId)
                                                        throws ApiException
```
Download live video Live videos are downloaded using this endpoint.

Parameters:

liveVideoId - The live video's unique identifier. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The live video's binary data. -

0 Unexpected error -

downloadLiveVideoAsync
```
public okhttp3.Call downloadLiveVideoAsync(UUID liveVideoId,
                                           ApiCallback<FileTransfer> _callback)
                                    throws ApiException
```
Download live video (asynchronously) Live videos are downloaded using this endpoint.

Parameters:

liveVideoId - The live video's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The live video's binary data. -

0 Unexpected error -

downloadLiveVideoFrameCall
```
public okhttp3.Call downloadLiveVideoFrameCall(UUID liveVideoId,
                                               ApiCallback _callback)
                                        throws ApiException
```
Build call for downloadLiveVideoFrame

Parameters:

liveVideoId - The live video's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The live video frame's binary data. -

0 Unexpected error -

downloadLiveVideoFrame
```
public FileTransfer downloadLiveVideoFrame(UUID liveVideoId)
                                    throws ApiException
```
Download live video frame Returns the binary data representing a single frame from a live video.

Parameters:

liveVideoId - The live video's unique identifier. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The live video frame's binary data. -

0 Unexpected error -

downloadLiveVideoFrameWithHttpInfo
```
public ApiResponse<FileTransfer> downloadLiveVideoFrameWithHttpInfo(UUID liveVideoId)
                                                             throws ApiException
```
Download live video frame Returns the binary data representing a single frame from a live video.

Parameters:

liveVideoId - The live video's unique identifier. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The live video frame's binary data. -

0 Unexpected error -

downloadLiveVideoFrameAsync
```
public okhttp3.Call downloadLiveVideoFrameAsync(UUID liveVideoId,
                                                ApiCallback<FileTransfer> _callback)
                                         throws ApiException
```
Download live video frame (asynchronously) Returns the binary data representing a single frame from a live video.

Parameters:

liveVideoId - The live video's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The live video frame's binary data. -

0 Unexpected error -

downloadMotionCaptureCall
```
public okhttp3.Call downloadMotionCaptureCall(UUID motionCaptureId,
                                              ApiCallback _callback)
                                       throws ApiException
```
Build call for downloadMotionCapture

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The motion capture's binary data. -

0 Unexpected error -

downloadMotionCapture
```
public FileTransfer downloadMotionCapture(UUID motionCaptureId)
                                   throws ApiException
```
Download motion capture Motion captures are downloaded using this endpoint.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The motion capture's binary data. -

0 Unexpected error -

downloadMotionCaptureWithHttpInfo
```
public ApiResponse<FileTransfer> downloadMotionCaptureWithHttpInfo(UUID motionCaptureId)
                                                            throws ApiException
```
Download motion capture Motion captures are downloaded using this endpoint.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The motion capture's binary data. -

0 Unexpected error -

downloadMotionCaptureAsync
```
public okhttp3.Call downloadMotionCaptureAsync(UUID motionCaptureId,
                                               ApiCallback<FileTransfer> _callback)
                                        throws ApiException
```
Download motion capture (asynchronously) Motion captures are downloaded using this endpoint.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The motion capture's binary data. -

0 Unexpected error -

downloadMotionCaptureFrameCall
```
public okhttp3.Call downloadMotionCaptureFrameCall(UUID motionCaptureId,
                                                   ApiCallback _callback)
                                            throws ApiException
```
Build call for downloadMotionCaptureFrame

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 The motion capture frame's binary data. -

0 Unexpected error -

downloadMotionCaptureFrame
```
public FileTransfer downloadMotionCaptureFrame(UUID motionCaptureId)
                                        throws ApiException
```
Download motion capture frame Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The motion capture frame's binary data. -

0 Unexpected error -

downloadMotionCaptureFrameWithHttpInfo
```
public ApiResponse<FileTransfer> downloadMotionCaptureFrameWithHttpInfo(UUID motionCaptureId)
                                                                 throws ApiException
```
Download motion capture frame Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 The motion capture frame's binary data. -

0 Unexpected error -

downloadMotionCaptureFrameAsync
```
public okhttp3.Call downloadMotionCaptureFrameAsync(UUID motionCaptureId,
                                                    ApiCallback<FileTransfer> _callback)
                                             throws ApiException
```
Download motion capture frame (asynchronously) Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 The motion capture frame's binary data. -

0 Unexpected error -

downloadQesDocumentCall

public okhttp3.Call downloadQesDocumentCall(UUID workflowRunId,
                                            UUID fileId,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for downloadQesDocument

Parameters:

workflowRunId - The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)

fileId - The unique identifier of the file which you want to retrieve. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed document PDF binary data.	-
0	Unexpected error	-

downloadQesDocument

public FileTransfer downloadQesDocument(UUID workflowRunId,
                                        UUID fileId)
                                 throws ApiException

Retrieves the signed document or application form Retrieves the signed document or application form depending on the file_id provided.

Parameters:

workflowRunId - The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)

fileId - The unique identifier of the file which you want to retrieve. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed document PDF binary data.	-
0	Unexpected error	-

downloadQesDocumentWithHttpInfo

public ApiResponse<FileTransfer> downloadQesDocumentWithHttpInfo(UUID workflowRunId,
                                                                 UUID fileId)
                                                          throws ApiException

Retrieves the signed document or application form Retrieves the signed document or application form depending on the file_id provided.

Parameters:

workflowRunId - The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)

fileId - The unique identifier of the file which you want to retrieve. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed document PDF binary data.	-
0	Unexpected error	-

downloadQesDocumentAsync

public okhttp3.Call downloadQesDocumentAsync(UUID workflowRunId,
                                             UUID fileId,
                                             ApiCallback<FileTransfer> _callback)
                                      throws ApiException

Retrieves the signed document or application form (asynchronously) Retrieves the signed document or application form depending on the file_id provided.

Parameters:

workflowRunId - The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)

fileId - The unique identifier of the file which you want to retrieve. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed document PDF binary data.	-
0	Unexpected error	-

downloadSignedEvidenceFileCall

public okhttp3.Call downloadSignedEvidenceFileCall(UUID workflowRunId,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for downloadSignedEvidenceFile

Parameters:

workflowRunId - Workflow Run ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed evidence PDF binary data.	-
0	Unexpected error	-

downloadSignedEvidenceFile

public FileTransfer downloadSignedEvidenceFile(UUID workflowRunId)
                                        throws ApiException

Retrieve Workflow Run Evidence Summary File Retrieves the signed evidence file for the designated Workflow Run

Parameters:

workflowRunId - Workflow Run ID (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed evidence PDF binary data.	-
0	Unexpected error	-

downloadSignedEvidenceFileWithHttpInfo

public ApiResponse<FileTransfer> downloadSignedEvidenceFileWithHttpInfo(UUID workflowRunId)
                                                                 throws ApiException

Retrieve Workflow Run Evidence Summary File Retrieves the signed evidence file for the designated Workflow Run

Parameters:

workflowRunId - Workflow Run ID (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed evidence PDF binary data.	-
0	Unexpected error	-

downloadSignedEvidenceFileAsync

public okhttp3.Call downloadSignedEvidenceFileAsync(UUID workflowRunId,
                                                    ApiCallback<FileTransfer> _callback)
                                             throws ApiException

Retrieve Workflow Run Evidence Summary File (asynchronously) Retrieves the signed evidence file for the designated Workflow Run

Parameters:

workflowRunId - Workflow Run ID (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The signed evidence PDF binary data.	-
0	Unexpected error	-

extractCall
```
public okhttp3.Call extractCall(ExtractRequest extractRequest,
                                ApiCallback _callback)
                         throws ApiException
```
Build call for extract

Parameters:

extractRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Extraction result -

0 Unprocessable Entity -

extract
```
public Extraction extract(ExtractRequest extractRequest)
                   throws ApiException
```
Autofill Extract information from a document

Parameters:

extractRequest - (required)

Returns:

Extraction

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Extraction result -

0 Unprocessable Entity -

extractWithHttpInfo
```
public ApiResponse<Extraction> extractWithHttpInfo(ExtractRequest extractRequest)
                                            throws ApiException
```
Autofill Extract information from a document

Parameters:

extractRequest - (required)

Returns:

ApiResponse<Extraction>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Extraction result -

0 Unprocessable Entity -

extractAsync
```
public okhttp3.Call extractAsync(ExtractRequest extractRequest,
                                 ApiCallback<Extraction> _callback)
                          throws ApiException
```
Autofill (asynchronously) Extract information from a document

Parameters:

extractRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Extraction result -

0 Unprocessable Entity -

findAddressesCall
```
public okhttp3.Call findAddressesCall(String postcode,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for findAddresses

Parameters:

postcode - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A list of addresses -

0 Unexpected error -

findAddresses
```
public AddressesList findAddresses(String postcode)
                            throws ApiException
```
Address Picker Search for addresses by postcode

Parameters:

postcode - (required)

Returns:

AddressesList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A list of addresses -

0 Unexpected error -

findAddressesWithHttpInfo
```
public ApiResponse<AddressesList> findAddressesWithHttpInfo(String postcode)
                                                     throws ApiException
```
Address Picker Search for addresses by postcode

Parameters:

postcode - (required)

Returns:

ApiResponse<AddressesList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A list of addresses -

0 Unexpected error -

findAddressesAsync
```
public okhttp3.Call findAddressesAsync(String postcode,
                                       ApiCallback<AddressesList> _callback)
                                throws ApiException
```
Address Picker (asynchronously) Search for addresses by postcode

Parameters:

postcode - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A list of addresses -

0 Unexpected error -

findApplicantCall
```
public okhttp3.Call findApplicantCall(UUID applicantId,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for findApplicant

Parameters:

applicantId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Applicant object -

0 Unexpected error -

findApplicant
```
public Applicant findApplicant(UUID applicantId)
                        throws ApiException
```
Retrieve Applicant Retrieves a single applicant. Returns an applicant object.

Parameters:

applicantId - (required)

Returns:

Applicant

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Applicant object -

0 Unexpected error -

findApplicantWithHttpInfo
```
public ApiResponse<Applicant> findApplicantWithHttpInfo(UUID applicantId)
                                                 throws ApiException
```
Retrieve Applicant Retrieves a single applicant. Returns an applicant object.

Parameters:

applicantId - (required)

Returns:

ApiResponse<Applicant>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Applicant object -

0 Unexpected error -

findApplicantAsync
```
public okhttp3.Call findApplicantAsync(UUID applicantId,
                                       ApiCallback<Applicant> _callback)
                                throws ApiException
```
Retrieve Applicant (asynchronously) Retrieves a single applicant. Returns an applicant object.

Parameters:

applicantId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Applicant object -

0 Unexpected error -

findCheckCall
```
public okhttp3.Call findCheckCall(UUID checkId,
                                  ApiCallback _callback)
                           throws ApiException
```
Build call for findCheck

Parameters:

checkId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Check object -

0 Unexpected error -

findCheck
```
public Check findCheck(UUID checkId)
                throws ApiException
```
Retrieve a Check Retrieves a single check. Returns a check object.

Parameters:

checkId - (required)

Returns:

Check

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Check object -

0 Unexpected error -

findCheckWithHttpInfo
```
public ApiResponse<Check> findCheckWithHttpInfo(UUID checkId)
                                         throws ApiException
```
Retrieve a Check Retrieves a single check. Returns a check object.

Parameters:

checkId - (required)

Returns:

ApiResponse<Check>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Check object -

0 Unexpected error -

findCheckAsync
```
public okhttp3.Call findCheckAsync(UUID checkId,
                                   ApiCallback<Check> _callback)
                            throws ApiException
```
Retrieve a Check (asynchronously) Retrieves a single check. Returns a check object.

Parameters:

checkId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Check object -

0 Unexpected error -

findDocumentCall
```
public okhttp3.Call findDocumentCall(UUID documentId,
                                     ApiCallback _callback)
                              throws ApiException
```
Build call for findDocument

Parameters:

documentId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A document -

0 Unexpected error -

findDocument
```
public Document findDocument(UUID documentId)
                      throws ApiException
```
Retrieve document A single document can be retrieved by calling this endpoint with the document's unique identifier.

Parameters:

documentId - (required)

Returns:

Document

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A document -

0 Unexpected error -

findDocumentWithHttpInfo
```
public ApiResponse<Document> findDocumentWithHttpInfo(UUID documentId)
                                               throws ApiException
```
Retrieve document A single document can be retrieved by calling this endpoint with the document's unique identifier.

Parameters:

documentId - (required)

Returns:

ApiResponse<Document>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A document -

0 Unexpected error -

findDocumentAsync
```
public okhttp3.Call findDocumentAsync(UUID documentId,
                                      ApiCallback<Document> _callback)
                               throws ApiException
```
Retrieve document (asynchronously) A single document can be retrieved by calling this endpoint with the document's unique identifier.

Parameters:

documentId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A document -

0 Unexpected error -

findIdPhotoCall
```
public okhttp3.Call findIdPhotoCall(UUID idPhotoId,
                                    ApiCallback _callback)
                             throws ApiException
```
Build call for findIdPhoto

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A ID photo -

0 Unexpected error -

findIdPhoto
```
public IdPhoto findIdPhoto(UUID idPhotoId)
                    throws ApiException
```
Retrieve ID photo Retrieves a single ID photo. Returns a ID photo object.

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

Returns:

IdPhoto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A ID photo -

0 Unexpected error -

findIdPhotoWithHttpInfo
```
public ApiResponse<IdPhoto> findIdPhotoWithHttpInfo(UUID idPhotoId)
                                             throws ApiException
```
Retrieve ID photo Retrieves a single ID photo. Returns a ID photo object.

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

Returns:

ApiResponse<IdPhoto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A ID photo -

0 Unexpected error -

findIdPhotoAsync
```
public okhttp3.Call findIdPhotoAsync(UUID idPhotoId,
                                     ApiCallback<IdPhoto> _callback)
                              throws ApiException
```
Retrieve ID photo (asynchronously) Retrieves a single ID photo. Returns a ID photo object.

Parameters:

idPhotoId - The ID photo's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A ID photo -

0 Unexpected error -

findLivePhotoCall
```
public okhttp3.Call findLivePhotoCall(UUID livePhotoId,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for findLivePhoto

Parameters:

livePhotoId - The live photo's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A live photo -

0 Unexpected error -

findLivePhoto
```
public LivePhoto findLivePhoto(UUID livePhotoId)
                        throws ApiException
```
Retrieve live photo Retrieves a single live photo. Returns a live photo object.

Parameters:

livePhotoId - The live photo's unique identifier. (required)

Returns:

LivePhoto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A live photo -

0 Unexpected error -

findLivePhotoWithHttpInfo
```
public ApiResponse<LivePhoto> findLivePhotoWithHttpInfo(UUID livePhotoId)
                                                 throws ApiException
```
Retrieve live photo Retrieves a single live photo. Returns a live photo object.

Parameters:

livePhotoId - The live photo's unique identifier. (required)

Returns:

ApiResponse<LivePhoto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A live photo -

0 Unexpected error -

findLivePhotoAsync
```
public okhttp3.Call findLivePhotoAsync(UUID livePhotoId,
                                       ApiCallback<LivePhoto> _callback)
                                throws ApiException
```
Retrieve live photo (asynchronously) Retrieves a single live photo. Returns a live photo object.

Parameters:

livePhotoId - The live photo's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A live photo -

0 Unexpected error -

findLiveVideoCall
```
public okhttp3.Call findLiveVideoCall(UUID liveVideoId,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for findLiveVideo

Parameters:

liveVideoId - The live video's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A live video -

0 Unexpected error -

findLiveVideo
```
public LiveVideo findLiveVideo(UUID liveVideoId)
                        throws ApiException
```
Retrieve live video Retrieves a single live video. Returns the corresponding live video object.

Parameters:

liveVideoId - The live video's unique identifier. (required)

Returns:

LiveVideo

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A live video -

0 Unexpected error -

findLiveVideoWithHttpInfo
```
public ApiResponse<LiveVideo> findLiveVideoWithHttpInfo(UUID liveVideoId)
                                                 throws ApiException
```
Retrieve live video Retrieves a single live video. Returns the corresponding live video object.

Parameters:

liveVideoId - The live video's unique identifier. (required)

Returns:

ApiResponse<LiveVideo>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A live video -

0 Unexpected error -

findLiveVideoAsync
```
public okhttp3.Call findLiveVideoAsync(UUID liveVideoId,
                                       ApiCallback<LiveVideo> _callback)
                                throws ApiException
```
Retrieve live video (asynchronously) Retrieves a single live video. Returns the corresponding live video object.

Parameters:

liveVideoId - The live video's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A live video -

0 Unexpected error -

findMotionCaptureCall
```
public okhttp3.Call findMotionCaptureCall(UUID motionCaptureId,
                                          ApiCallback _callback)
                                   throws ApiException
```
Build call for findMotionCapture

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A motion capture -

0 Unexpected error -

findMotionCapture
```
public MotionCapture findMotionCapture(UUID motionCaptureId)
                                throws ApiException
```
Retrieve motion capture Retrieves a single motion capture. Returns the corresponding motion capture object.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

Returns:

MotionCapture

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A motion capture -

0 Unexpected error -

findMotionCaptureWithHttpInfo
```
public ApiResponse<MotionCapture> findMotionCaptureWithHttpInfo(UUID motionCaptureId)
                                                         throws ApiException
```
Retrieve motion capture Retrieves a single motion capture. Returns the corresponding motion capture object.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

Returns:

ApiResponse<MotionCapture>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A motion capture -

0 Unexpected error -

findMotionCaptureAsync
```
public okhttp3.Call findMotionCaptureAsync(UUID motionCaptureId,
                                           ApiCallback<MotionCapture> _callback)
                                    throws ApiException
```
Retrieve motion capture (asynchronously) Retrieves a single motion capture. Returns the corresponding motion capture object.

Parameters:

motionCaptureId - The motion capture's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A motion capture -

0 Unexpected error -

findReportCall
```
public okhttp3.Call findReportCall(UUID reportId,
                                   ApiCallback _callback)
                            throws ApiException
```
Build call for findReport

Parameters:

reportId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Report object -

0 Unexpected error -

findReport
```
public Report findReport(UUID reportId)
                  throws ApiException
```
Retrieve report A single report can be retrieved using this endpoint with the corresponding unique identifier.

Parameters:

reportId - (required)

Returns:

Report

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Report object -

0 Unexpected error -

findReportWithHttpInfo
```
public ApiResponse<Report> findReportWithHttpInfo(UUID reportId)
                                           throws ApiException
```
Retrieve report A single report can be retrieved using this endpoint with the corresponding unique identifier.

Parameters:

reportId - (required)

Returns:

ApiResponse<Report>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Report object -

0 Unexpected error -

findReportAsync
```
public okhttp3.Call findReportAsync(UUID reportId,
                                    ApiCallback<Report> _callback)
                             throws ApiException
```
Retrieve report (asynchronously) A single report can be retrieved using this endpoint with the corresponding unique identifier.

Parameters:

reportId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Report object -

0 Unexpected error -

findTaskCall
```
public okhttp3.Call findTaskCall(UUID workflowRunId,
                                 String taskId,
                                 ApiCallback _callback)
                          throws ApiException
```
Build call for findTask

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to retrieve. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A Task object. -

0 Unexpected error -

findTask
```
public Task findTask(UUID workflowRunId,
                     String taskId)
              throws ApiException
```
Retrieve Task A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to retrieve. (required)

Returns:

Task

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A Task object. -

0 Unexpected error -

findTaskWithHttpInfo
```
public ApiResponse<Task> findTaskWithHttpInfo(UUID workflowRunId,
                                              String taskId)
                                       throws ApiException
```
Retrieve Task A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to retrieve. (required)

Returns:

ApiResponse<Task>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A Task object. -

0 Unexpected error -

findTaskAsync
```
public okhttp3.Call findTaskAsync(UUID workflowRunId,
                                  String taskId,
                                  ApiCallback<Task> _callback)
                           throws ApiException
```
Retrieve Task (asynchronously) A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Task belongs. (required)

taskId - The identifier of the Task you want to retrieve. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A Task object. -

0 Unexpected error -

findTimelineFileCall

public okhttp3.Call findTimelineFileCall(UUID workflowRunId,
                                         UUID timelineFileId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for findTimelineFile

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

timelineFileId - The unique identifier for the Timefile File. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The Timeline File PDF binary data.	-
0	Unexpected error	-

findTimelineFile

public FileTransfer findTimelineFile(UUID workflowRunId,
                                     UUID timelineFileId)
                              throws ApiException

Retrieve Timeline File for Workflow Run Retrieves the Timeline File for the designated Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

timelineFileId - The unique identifier for the Timefile File. (required)

Returns:

FileTransfer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The Timeline File PDF binary data.	-
0	Unexpected error	-

findTimelineFileWithHttpInfo

public ApiResponse<FileTransfer> findTimelineFileWithHttpInfo(UUID workflowRunId,
                                                              UUID timelineFileId)
                                                       throws ApiException

Retrieve Timeline File for Workflow Run Retrieves the Timeline File for the designated Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

timelineFileId - The unique identifier for the Timefile File. (required)

Returns:

ApiResponse<FileTransfer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The Timeline File PDF binary data.	-
0	Unexpected error	-

findTimelineFileAsync

public okhttp3.Call findTimelineFileAsync(UUID workflowRunId,
                                          UUID timelineFileId,
                                          ApiCallback<FileTransfer> _callback)
                                   throws ApiException

Retrieve Timeline File for Workflow Run (asynchronously) Retrieves the Timeline File for the designated Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

timelineFileId - The unique identifier for the Timefile File. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
302	Found	* Location - Link to the Timeline File.
200	The Timeline File PDF binary data.	-
0	Unexpected error	-

findWatchlistMonitorCall
```
public okhttp3.Call findWatchlistMonitorCall(UUID monitorId,
                                             ApiCallback _callback)
                                      throws ApiException
```
Build call for findWatchlistMonitor

Parameters:

monitorId - The watchlist monitor's unique identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A watchlist monitor -

0 Unexpected error -

findWatchlistMonitor
```
public WatchlistMonitor findWatchlistMonitor(UUID monitorId)
                                      throws ApiException
```
Retrieve monitor Retrieves a single monitor

Parameters:

monitorId - The watchlist monitor's unique identifier. (required)

Returns:

WatchlistMonitor

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A watchlist monitor -

0 Unexpected error -

findWatchlistMonitorWithHttpInfo
```
public ApiResponse<WatchlistMonitor> findWatchlistMonitorWithHttpInfo(UUID monitorId)
                                                               throws ApiException
```
Retrieve monitor Retrieves a single monitor

Parameters:

monitorId - The watchlist monitor's unique identifier. (required)

Returns:

ApiResponse<WatchlistMonitor>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A watchlist monitor -

0 Unexpected error -

findWatchlistMonitorAsync
```
public okhttp3.Call findWatchlistMonitorAsync(UUID monitorId,
                                              ApiCallback<WatchlistMonitor> _callback)
                                       throws ApiException
```
Retrieve monitor (asynchronously) Retrieves a single monitor

Parameters:

monitorId - The watchlist monitor's unique identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A watchlist monitor -

0 Unexpected error -

findWebhookCall
```
public okhttp3.Call findWebhookCall(UUID webhookId,
                                    ApiCallback _callback)
                             throws ApiException
```
Build call for findWebhook

Parameters:

webhookId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Webhook object -

0 Unexpected error -

findWebhook
```
public Webhook findWebhook(UUID webhookId)
                    throws ApiException
```
Retrieve a Webhook Retrieves a single webhook. Returns a webhook object.

Parameters:

webhookId - (required)

Returns:

Webhook

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Webhook object -

0 Unexpected error -

findWebhookWithHttpInfo
```
public ApiResponse<Webhook> findWebhookWithHttpInfo(UUID webhookId)
                                             throws ApiException
```
Retrieve a Webhook Retrieves a single webhook. Returns a webhook object.

Parameters:

webhookId - (required)

Returns:

ApiResponse<Webhook>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Webhook object -

0 Unexpected error -

findWebhookAsync
```
public okhttp3.Call findWebhookAsync(UUID webhookId,
                                     ApiCallback<Webhook> _callback)
                              throws ApiException
```
Retrieve a Webhook (asynchronously) Retrieves a single webhook. Returns a webhook object.

Parameters:

webhookId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Webhook object -

0 Unexpected error -

findWorkflowRunCall
```
public okhttp3.Call findWorkflowRunCall(UUID workflowRunId,
                                        ApiCallback _callback)
                                 throws ApiException
```
Build call for findWorkflowRun

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A Workflow Run object. -

0 Unexpected error -

findWorkflowRun
```
public WorkflowRun findWorkflowRun(UUID workflowRunId)
                            throws ApiException
```
Retrieve Workflow Run A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

Returns:

WorkflowRun

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A Workflow Run object. -

0 Unexpected error -

findWorkflowRunWithHttpInfo
```
public ApiResponse<WorkflowRun> findWorkflowRunWithHttpInfo(UUID workflowRunId)
                                                     throws ApiException
```
Retrieve Workflow Run A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

Returns:

ApiResponse<WorkflowRun>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A Workflow Run object. -

0 Unexpected error -

findWorkflowRunAsync
```
public okhttp3.Call findWorkflowRunAsync(UUID workflowRunId,
                                         ApiCallback<WorkflowRun> _callback)
                                  throws ApiException
```
Retrieve Workflow Run (asynchronously) A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A Workflow Run object. -

0 Unexpected error -

forceReportCreationFromWatchlistMonitorCall
```
public okhttp3.Call forceReportCreationFromWatchlistMonitorCall(UUID monitorId,
                                                                ApiCallback _callback)
                                                         throws ApiException
```
Build call for forceReportCreationFromWatchlistMonitor

Parameters:

monitorId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 Created * Location - Link to the newly generated report.

0 Unexpected error -

forceReportCreationFromWatchlistMonitor
```
public void forceReportCreationFromWatchlistMonitor(UUID monitorId)
                                             throws ApiException
```
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.

Parameters:

monitorId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created * Location - Link to the newly generated report.

0 Unexpected error -

forceReportCreationFromWatchlistMonitorWithHttpInfo
```
public ApiResponse<Void> forceReportCreationFromWatchlistMonitorWithHttpInfo(UUID monitorId)
                                                                      throws ApiException
```
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.

Parameters:

monitorId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Created * Location - Link to the newly generated report.

0 Unexpected error -

forceReportCreationFromWatchlistMonitorAsync
```
public okhttp3.Call forceReportCreationFromWatchlistMonitorAsync(UUID monitorId,
                                                                 ApiCallback<Void> _callback)
                                                          throws ApiException
```
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.

Parameters:

monitorId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 Created * Location - Link to the newly generated report.

0 Unexpected error -

generateSdkTokenCall
```
public okhttp3.Call generateSdkTokenCall(SdkTokenBuilder sdkTokenBuilder,
                                         ApiCallback _callback)
                                  throws ApiException
```
Build call for generateSdkToken

Parameters:

sdkTokenBuilder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Generated -

0 Unexpected error -

generateSdkToken
```
public SdkToken generateSdkToken(SdkTokenBuilder sdkTokenBuilder)
                          throws ApiException
```
Generate a SDK token Generates an SDK token. Returns a token object containing the SDK token.

Parameters:

sdkTokenBuilder - (required)

Returns:

SdkToken

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Generated -

0 Unexpected error -

generateSdkTokenWithHttpInfo
```
public ApiResponse<SdkToken> generateSdkTokenWithHttpInfo(SdkTokenBuilder sdkTokenBuilder)
                                                   throws ApiException
```
Generate a SDK token Generates an SDK token. Returns a token object containing the SDK token.

Parameters:

sdkTokenBuilder - (required)

Returns:

ApiResponse<SdkToken>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Generated -

0 Unexpected error -

generateSdkTokenAsync
```
public okhttp3.Call generateSdkTokenAsync(SdkTokenBuilder sdkTokenBuilder,
                                          ApiCallback<SdkToken> _callback)
                                   throws ApiException
```
Generate a SDK token (asynchronously) Generates an SDK token. Returns a token object containing the SDK token.

Parameters:

sdkTokenBuilder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Generated -

0 Unexpected error -

listApplicantsCall
```
public okhttp3.Call listApplicantsCall(Integer page,
                                       Integer perPage,
                                       Boolean includeDeleted,
                                       ApiCallback _callback)
                                throws ApiException
```
Build call for listApplicants

Parameters:

page - The page to return. The first page is `page=1` (optional, default to 1)

perPage - The number of objects per page. (optional, default to 20)

includeDeleted - Whether to also include applicants scheduled for deletion. (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A list of applicants -

0 Unexpected error -

listApplicants
```
public ApplicantsList listApplicants(Integer page,
                                     Integer perPage,
                                     Boolean includeDeleted)
                              throws ApiException
```
List Applicants Lists all applicants you've created, sorted by creation date in descending order.

Parameters:

page - The page to return. The first page is `page=1` (optional, default to 1)

perPage - The number of objects per page. (optional, default to 20)

includeDeleted - Whether to also include applicants scheduled for deletion. (optional, default to false)

Returns:

ApplicantsList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A list of applicants -

0 Unexpected error -

listApplicantsWithHttpInfo
```
public ApiResponse<ApplicantsList> listApplicantsWithHttpInfo(Integer page,
                                                              Integer perPage,
                                                              Boolean includeDeleted)
                                                       throws ApiException
```
List Applicants Lists all applicants you've created, sorted by creation date in descending order.

Parameters:

page - The page to return. The first page is `page=1` (optional, default to 1)

perPage - The number of objects per page. (optional, default to 20)

includeDeleted - Whether to also include applicants scheduled for deletion. (optional, default to false)

Returns:

ApiResponse<ApplicantsList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A list of applicants -

0 Unexpected error -

listApplicantsAsync
```
public okhttp3.Call listApplicantsAsync(Integer page,
                                        Integer perPage,
                                        Boolean includeDeleted,
                                        ApiCallback<ApplicantsList> _callback)
                                 throws ApiException
```
List Applicants (asynchronously) Lists all applicants you've created, sorted by creation date in descending order.

Parameters:

page - The page to return. The first page is `page=1` (optional, default to 1)

perPage - The number of objects per page. (optional, default to 20)

includeDeleted - Whether to also include applicants scheduled for deletion. (optional, default to false)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A list of applicants -

0 Unexpected error -

listChecksCall
```
public okhttp3.Call listChecksCall(UUID applicantId,
                                   ApiCallback _callback)
                            throws ApiException
```
Build call for listChecks

Parameters:

applicantId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of checks -

0 Unexpected error -

listChecks
```
public ChecksList listChecks(UUID applicantId)
                      throws ApiException
```
Retrieve Checks Retrieves a single check. Returns a check object.

Parameters:

applicantId - (required)

Returns:

ChecksList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of checks -

0 Unexpected error -

listChecksWithHttpInfo
```
public ApiResponse<ChecksList> listChecksWithHttpInfo(UUID applicantId)
                                               throws ApiException
```
Retrieve Checks Retrieves a single check. Returns a check object.

Parameters:

applicantId - (required)

Returns:

ApiResponse<ChecksList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of checks -

0 Unexpected error -

listChecksAsync
```
public okhttp3.Call listChecksAsync(UUID applicantId,
                                    ApiCallback<ChecksList> _callback)
                             throws ApiException
```
Retrieve Checks (asynchronously) Retrieves a single check. Returns a check object.

Parameters:

applicantId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of checks -

0 Unexpected error -

listDocumentsCall
```
public okhttp3.Call listDocumentsCall(UUID applicantId,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for listDocuments

Parameters:

applicantId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 List of Documents -

0 Unexpected error -

listDocuments
```
public DocumentsList listDocuments(UUID applicantId)
                            throws ApiException
```
List documents All documents belonging to an applicant can be listed from this endpoint

Parameters:

applicantId - (required)

Returns:

DocumentsList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List of Documents -

0 Unexpected error -

listDocumentsWithHttpInfo
```
public ApiResponse<DocumentsList> listDocumentsWithHttpInfo(UUID applicantId)
                                                     throws ApiException
```
List documents All documents belonging to an applicant can be listed from this endpoint

Parameters:

applicantId - (required)

Returns:

ApiResponse<DocumentsList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List of Documents -

0 Unexpected error -

listDocumentsAsync
```
public okhttp3.Call listDocumentsAsync(UUID applicantId,
                                       ApiCallback<DocumentsList> _callback)
                                throws ApiException
```
List documents (asynchronously) All documents belonging to an applicant can be listed from this endpoint

Parameters:

applicantId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 List of Documents -

0 Unexpected error -

listIdPhotosCall
```
public okhttp3.Call listIdPhotosCall(UUID applicantId,
                                     ApiCallback _callback)
                              throws ApiException
```
Build call for listIdPhotos

Parameters:

applicantId - The id of the applicant the ID photos belong to. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of ID photos -

0 Unexpected error -

listIdPhotos
```
public IdPhotosList listIdPhotos(UUID applicantId)
                          throws ApiException
```
List ID photos Lists the ID photos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the ID photos belong to. (required)

Returns:

IdPhotosList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of ID photos -

0 Unexpected error -

listIdPhotosWithHttpInfo
```
public ApiResponse<IdPhotosList> listIdPhotosWithHttpInfo(UUID applicantId)
                                                   throws ApiException
```
List ID photos Lists the ID photos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the ID photos belong to. (required)

Returns:

ApiResponse<IdPhotosList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of ID photos -

0 Unexpected error -

listIdPhotosAsync
```
public okhttp3.Call listIdPhotosAsync(UUID applicantId,
                                      ApiCallback<IdPhotosList> _callback)
                               throws ApiException
```
List ID photos (asynchronously) Lists the ID photos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the ID photos belong to. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of ID photos -

0 Unexpected error -

listLivePhotosCall
```
public okhttp3.Call listLivePhotosCall(UUID applicantId,
                                       ApiCallback _callback)
                                throws ApiException
```
Build call for listLivePhotos

Parameters:

applicantId - The id of the applicant the live photos belong to. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of live photos -

0 Unexpected error -

listLivePhotos
```
public LivePhotosList listLivePhotos(UUID applicantId)
                              throws ApiException
```
List live photos Lists the live photos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the live photos belong to. (required)

Returns:

LivePhotosList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of live photos -

0 Unexpected error -

listLivePhotosWithHttpInfo
```
public ApiResponse<LivePhotosList> listLivePhotosWithHttpInfo(UUID applicantId)
                                                       throws ApiException
```
List live photos Lists the live photos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the live photos belong to. (required)

Returns:

ApiResponse<LivePhotosList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of live photos -

0 Unexpected error -

listLivePhotosAsync
```
public okhttp3.Call listLivePhotosAsync(UUID applicantId,
                                        ApiCallback<LivePhotosList> _callback)
                                 throws ApiException
```
List live photos (asynchronously) Lists the live photos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the live photos belong to. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of live photos -

0 Unexpected error -

listLiveVideosCall
```
public okhttp3.Call listLiveVideosCall(UUID applicantId,
                                       ApiCallback _callback)
                                throws ApiException
```
Build call for listLiveVideos

Parameters:

applicantId - The id of the applicant the live videos belong to. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of live videos -

0 Unexpected error -

listLiveVideos
```
public LiveVideosList listLiveVideos(UUID applicantId)
                              throws ApiException
```
List live videos Lists all the live videos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the live videos belong to. (required)

Returns:

LiveVideosList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of live videos -

0 Unexpected error -

listLiveVideosWithHttpInfo
```
public ApiResponse<LiveVideosList> listLiveVideosWithHttpInfo(UUID applicantId)
                                                       throws ApiException
```
List live videos Lists all the live videos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the live videos belong to. (required)

Returns:

ApiResponse<LiveVideosList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of live videos -

0 Unexpected error -

listLiveVideosAsync
```
public okhttp3.Call listLiveVideosAsync(UUID applicantId,
                                        ApiCallback<LiveVideosList> _callback)
                                 throws ApiException
```
List live videos (asynchronously) Lists all the live videos that belong to an applicant.

Parameters:

applicantId - The id of the applicant the live videos belong to. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of live videos -

0 Unexpected error -

listMotionCapturesCall
```
public okhttp3.Call listMotionCapturesCall(UUID applicantId,
                                           ApiCallback _callback)
                                    throws ApiException
```
Build call for listMotionCaptures

Parameters:

applicantId - The id of the applicant the motion captures belong to. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of motion captures -

0 Unexpected error -

listMotionCaptures
```
public MotionCapturesList listMotionCaptures(UUID applicantId)
                                      throws ApiException
```
List motion captures Lists all the motion captures that belong to an applicant.

Parameters:

applicantId - The id of the applicant the motion captures belong to. (required)

Returns:

MotionCapturesList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of motion captures -

0 Unexpected error -

listMotionCapturesWithHttpInfo
```
public ApiResponse<MotionCapturesList> listMotionCapturesWithHttpInfo(UUID applicantId)
                                                               throws ApiException
```
List motion captures Lists all the motion captures that belong to an applicant.

Parameters:

applicantId - The id of the applicant the motion captures belong to. (required)

Returns:

ApiResponse<MotionCapturesList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of motion captures -

0 Unexpected error -

listMotionCapturesAsync
```
public okhttp3.Call listMotionCapturesAsync(UUID applicantId,
                                            ApiCallback<MotionCapturesList> _callback)
                                     throws ApiException
```
List motion captures (asynchronously) Lists all the motion captures that belong to an applicant.

Parameters:

applicantId - The id of the applicant the motion captures belong to. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of motion captures -

0 Unexpected error -

listRepeatAttemptsCall
```
public okhttp3.Call listRepeatAttemptsCall(UUID reportId,
                                           ApiCallback _callback)
                                    throws ApiException
```
Build call for listRepeatAttempts

Parameters:

reportId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Repeat attempts object -

0 Unexpected error -

listRepeatAttempts
```
public RepeatAttemptsList listRepeatAttempts(UUID reportId)
                                      throws ApiException
```
Retrieve repeat attempts Returns all repeat attempts for a given Document report

Parameters:

reportId - (required)

Returns:

RepeatAttemptsList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Repeat attempts object -

0 Unexpected error -

listRepeatAttemptsWithHttpInfo
```
public ApiResponse<RepeatAttemptsList> listRepeatAttemptsWithHttpInfo(UUID reportId)
                                                               throws ApiException
```
Retrieve repeat attempts Returns all repeat attempts for a given Document report

Parameters:

reportId - (required)

Returns:

ApiResponse<RepeatAttemptsList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Repeat attempts object -

0 Unexpected error -

listRepeatAttemptsAsync
```
public okhttp3.Call listRepeatAttemptsAsync(UUID reportId,
                                            ApiCallback<RepeatAttemptsList> _callback)
                                     throws ApiException
```
Retrieve repeat attempts (asynchronously) Returns all repeat attempts for a given Document report

Parameters:

reportId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Repeat attempts object -

0 Unexpected error -

listReportsCall
```
public okhttp3.Call listReportsCall(UUID checkId,
                                    ApiCallback _callback)
                             throws ApiException
```
Build call for listReports

Parameters:

checkId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 List of Reports -

0 Unexpected error -

listReports
```
public ReportsList listReports(UUID checkId)
                        throws ApiException
```
List reports All the reports belonging to a particular check can be listed from this endpoint.

Parameters:

checkId - (required)

Returns:

ReportsList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List of Reports -

0 Unexpected error -

listReportsWithHttpInfo
```
public ApiResponse<ReportsList> listReportsWithHttpInfo(UUID checkId)
                                                 throws ApiException
```
List reports All the reports belonging to a particular check can be listed from this endpoint.

Parameters:

checkId - (required)

Returns:

ApiResponse<ReportsList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List of Reports -

0 Unexpected error -

listReportsAsync
```
public okhttp3.Call listReportsAsync(UUID checkId,
                                     ApiCallback<ReportsList> _callback)
                              throws ApiException
```
List reports (asynchronously) All the reports belonging to a particular check can be listed from this endpoint.

Parameters:

checkId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 List of Reports -

0 Unexpected error -

listTasksCall

public okhttp3.Call listTasksCall(UUID workflowRunId,
                                  ApiCallback _callback)
                           throws ApiException

Build call for listTasks

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Tasks belong. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	An array of subset Task objects that were already started or completed, ordered by the created_at field, in ascending order.	-
0	Unexpected error	-

listTasks

public List<TaskItem> listTasks(UUID workflowRunId)
                         throws ApiException

List Tasks The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Tasks belong. (required)

Returns:

List<TaskItem>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	An array of subset Task objects that were already started or completed, ordered by the created_at field, in ascending order.	-
0	Unexpected error	-

listTasksWithHttpInfo

public ApiResponse<List<TaskItem>> listTasksWithHttpInfo(UUID workflowRunId)
                                                  throws ApiException

List Tasks The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Tasks belong. (required)

Returns:

ApiResponse<List<TaskItem>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	An array of subset Task objects that were already started or completed, ordered by the created_at field, in ascending order.	-
0	Unexpected error	-

listTasksAsync

public okhttp3.Call listTasksAsync(UUID workflowRunId,
                                   ApiCallback<List<TaskItem>> _callback)
                            throws ApiException

List Tasks (asynchronously) The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.

Parameters:

workflowRunId - The unique identifier of the Workflow Run to which the Tasks belong. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	An array of subset Task objects that were already started or completed, ordered by the created_at field, in ascending order.	-
0	Unexpected error	-

listWatchlistMonitorMatchesCall
```
public okhttp3.Call listWatchlistMonitorMatchesCall(UUID monitorId,
                                                    ApiCallback _callback)
                                             throws ApiException
```
Build call for listWatchlistMonitorMatches

Parameters:

monitorId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

listWatchlistMonitorMatches
```
public WatchlistMonitorMatchesList listWatchlistMonitorMatches(UUID monitorId)
                                                        throws ApiException
```
List matches (BETA) List match IDs on this monitor, as well as their enabled/disabled status

Parameters:

monitorId - (required)

Returns:

WatchlistMonitorMatchesList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

listWatchlistMonitorMatchesWithHttpInfo
```
public ApiResponse<WatchlistMonitorMatchesList> listWatchlistMonitorMatchesWithHttpInfo(UUID monitorId)
                                                                                 throws ApiException
```
List matches (BETA) List match IDs on this monitor, as well as their enabled/disabled status

Parameters:

monitorId - (required)

Returns:

ApiResponse<WatchlistMonitorMatchesList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

listWatchlistMonitorMatchesAsync
```
public okhttp3.Call listWatchlistMonitorMatchesAsync(UUID monitorId,
                                                     ApiCallback<WatchlistMonitorMatchesList> _callback)
                                              throws ApiException
```
List matches (BETA) (asynchronously) List match IDs on this monitor, as well as their enabled/disabled status

Parameters:

monitorId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

listWatchlistMonitorsCall
```
public okhttp3.Call listWatchlistMonitorsCall(UUID applicantId,
                                              Boolean includeDeleted,
                                              ApiCallback _callback)
                                       throws ApiException
```
Build call for listWatchlistMonitors

Parameters:

applicantId - The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required)

includeDeleted - Whether to also include deleted (inactive) monitors. (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

0 Unexpected error -

listWatchlistMonitors
```
public WatchlistMonitorsList listWatchlistMonitors(UUID applicantId,
                                                   Boolean includeDeleted)
                                            throws ApiException
```
List monitors List all available monitors for an applicant

Parameters:

applicantId - The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required)

includeDeleted - Whether to also include deleted (inactive) monitors. (optional, default to false)

Returns:

WatchlistMonitorsList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

0 Unexpected error -

listWatchlistMonitorsWithHttpInfo
```
public ApiResponse<WatchlistMonitorsList> listWatchlistMonitorsWithHttpInfo(UUID applicantId,
                                                                            Boolean includeDeleted)
                                                                     throws ApiException
```
List monitors List all available monitors for an applicant

Parameters:

applicantId - The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required)

includeDeleted - Whether to also include deleted (inactive) monitors. (optional, default to false)

Returns:

ApiResponse<WatchlistMonitorsList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

0 Unexpected error -

listWatchlistMonitorsAsync
```
public okhttp3.Call listWatchlistMonitorsAsync(UUID applicantId,
                                               Boolean includeDeleted,
                                               ApiCallback<WatchlistMonitorsList> _callback)
                                        throws ApiException
```
List monitors (asynchronously) List all available monitors for an applicant

Parameters:

applicantId - The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required)

includeDeleted - Whether to also include deleted (inactive) monitors. (optional, default to false)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

0 Unexpected error -

listWebhooksCall
```
public okhttp3.Call listWebhooksCall(ApiCallback _callback)
                              throws ApiException
```
Build call for listWebhooks

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 A list of webhooks -

0 Unexpected error -

listWebhooks
```
public WebhooksList listWebhooks()
                          throws ApiException
```
List webhooks Lists all webhooks you've created.

Returns:

WebhooksList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A list of webhooks -

0 Unexpected error -

listWebhooksWithHttpInfo
```
public ApiResponse<WebhooksList> listWebhooksWithHttpInfo()
                                                   throws ApiException
```
List webhooks Lists all webhooks you've created.

Returns:

ApiResponse<WebhooksList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 A list of webhooks -

0 Unexpected error -

listWebhooksAsync
```
public okhttp3.Call listWebhooksAsync(ApiCallback<WebhooksList> _callback)
                               throws ApiException
```
List webhooks (asynchronously) Lists all webhooks you've created.

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 A list of webhooks -

0 Unexpected error -

listWorkflowRunsCall
```
public okhttp3.Call listWorkflowRunsCall(Integer page,
                                         String status,
                                         OffsetDateTime createdAtGt,
                                         OffsetDateTime createdAtLt,
                                         String sort,
                                         ApiCallback _callback)
                                  throws ApiException
```
Build call for listWorkflowRuns

Parameters:

page - The number of the page to be retrieved. If not specified, defaults to 1. (optional, default to 1)

status - A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. (optional)

createdAtGt - A ISO-8601 date to filter results with a created date greater than (after) the one provided. (optional)

createdAtLt - A ISO-8601 date to filter results with a created date less than (before) the one provided. (optional)

sort - A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. (optional, default to desc)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of Workflow Run objects matching the query parameters. -

0 Unexpected error -

listWorkflowRuns
```
public List<WorkflowRun> listWorkflowRuns(Integer page,
                                          String status,
                                          OffsetDateTime createdAtGt,
                                          OffsetDateTime createdAtLt,
                                          String sort)
                                   throws ApiException
```
List Workflow Runs Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.

Parameters:

page - The number of the page to be retrieved. If not specified, defaults to 1. (optional, default to 1)

status - A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. (optional)

createdAtGt - A ISO-8601 date to filter results with a created date greater than (after) the one provided. (optional)

createdAtLt - A ISO-8601 date to filter results with a created date less than (before) the one provided. (optional)

sort - A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. (optional, default to desc)

Returns:

List<WorkflowRun>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of Workflow Run objects matching the query parameters. -

0 Unexpected error -

listWorkflowRunsWithHttpInfo
```
public ApiResponse<List<WorkflowRun>> listWorkflowRunsWithHttpInfo(Integer page,
                                                                   String status,
                                                                   OffsetDateTime createdAtGt,
                                                                   OffsetDateTime createdAtLt,
                                                                   String sort)
                                                            throws ApiException
```
List Workflow Runs Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.

Parameters:

page - The number of the page to be retrieved. If not specified, defaults to 1. (optional, default to 1)

status - A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. (optional)

createdAtGt - A ISO-8601 date to filter results with a created date greater than (after) the one provided. (optional)

createdAtLt - A ISO-8601 date to filter results with a created date less than (before) the one provided. (optional)

sort - A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. (optional, default to desc)

Returns:

ApiResponse<List<WorkflowRun>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of Workflow Run objects matching the query parameters. -

0 Unexpected error -

listWorkflowRunsAsync
```
public okhttp3.Call listWorkflowRunsAsync(Integer page,
                                          String status,
                                          OffsetDateTime createdAtGt,
                                          OffsetDateTime createdAtLt,
                                          String sort,
                                          ApiCallback<List<WorkflowRun>> _callback)
                                   throws ApiException
```
List Workflow Runs (asynchronously) Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.

Parameters:

page - The number of the page to be retrieved. If not specified, defaults to 1. (optional, default to 1)

status - A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. (optional)

createdAtGt - A ISO-8601 date to filter results with a created date greater than (after) the one provided. (optional)

createdAtLt - A ISO-8601 date to filter results with a created date less than (before) the one provided. (optional)

sort - A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. (optional, default to desc)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of Workflow Run objects matching the query parameters. -

0 Unexpected error -

pingCall
```
public okhttp3.Call pingCall(ApiCallback _callback)
                      throws ApiException
```
Build call for ping

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Regional base URL is operational -

0 Unexpected error -

ping
```
public String ping()
            throws ApiException
```
Ping Run a health check on the Onfido API

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Regional base URL is operational -

0 Unexpected error -

pingWithHttpInfo
```
public ApiResponse<String> pingWithHttpInfo()
                                     throws ApiException
```
Ping Run a health check on the Onfido API

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Regional base URL is operational -

0 Unexpected error -

pingAsync
```
public okhttp3.Call pingAsync(ApiCallback<String> _callback)
                       throws ApiException
```
Ping (asynchronously) Run a health check on the Onfido API

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Regional base URL is operational -

0 Unexpected error -

postResultsFeedbackCall
```
public okhttp3.Call postResultsFeedbackCall(ResultsFeedback resultsFeedback,
                                            ApiCallback _callback)
                                     throws ApiException
```
Build call for postResultsFeedback

Parameters:

resultsFeedback - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Created feedback -

0 Unexpected error -

postResultsFeedback
```
public ResultsFeedback postResultsFeedback(ResultsFeedback resultsFeedback)
                                    throws ApiException
```
Fraud reporting (ALPHA) Create Feedback on checks and reports

Parameters:

resultsFeedback - (required)

Returns:

ResultsFeedback

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Created feedback -

0 Unexpected error -

postResultsFeedbackWithHttpInfo
```
public ApiResponse<ResultsFeedback> postResultsFeedbackWithHttpInfo(ResultsFeedback resultsFeedback)
                                                             throws ApiException
```
Fraud reporting (ALPHA) Create Feedback on checks and reports

Parameters:

resultsFeedback - (required)

Returns:

ApiResponse<ResultsFeedback>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Created feedback -

0 Unexpected error -

postResultsFeedbackAsync
```
public okhttp3.Call postResultsFeedbackAsync(ResultsFeedback resultsFeedback,
                                             ApiCallback<ResultsFeedback> _callback)
                                      throws ApiException
```
Fraud reporting (ALPHA) (asynchronously) Create Feedback on checks and reports

Parameters:

resultsFeedback - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Created feedback -

0 Unexpected error -

resendWebhooksCall

public okhttp3.Call resendWebhooksCall(WebhookResend webhookResend,
                                       ApiCallback _callback)
                                throws ApiException

Build call for resendWebhooks

Parameters:

webhookResend - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Webhooks are resent for the respective checks	-
422	Request was received but it could not be processed	-
0	Unexpected error	-

resendWebhooks

public void resendWebhooks(WebhookResend webhookResend)
                    throws ApiException

Resends webhooks Resends events to all webhooks registered with a matching environment in your account.

Parameters:

webhookResend - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Webhooks are resent for the respective checks	-
422	Request was received but it could not be processed	-
0	Unexpected error	-

resendWebhooksWithHttpInfo

public ApiResponse<Void> resendWebhooksWithHttpInfo(WebhookResend webhookResend)
                                             throws ApiException

Resends webhooks Resends events to all webhooks registered with a matching environment in your account.

Parameters:

webhookResend - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Webhooks are resent for the respective checks	-
422	Request was received but it could not be processed	-
0	Unexpected error	-

resendWebhooksAsync

public okhttp3.Call resendWebhooksAsync(WebhookResend webhookResend,
                                        ApiCallback<Void> _callback)
                                 throws ApiException

Resends webhooks (asynchronously) Resends events to all webhooks registered with a matching environment in your account.

Parameters:

webhookResend - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Webhooks are resent for the respective checks	-
422	Request was received but it could not be processed	-
0	Unexpected error	-

restoreApplicantCall
```
public okhttp3.Call restoreApplicantCall(UUID applicantId,
                                         ApiCallback _callback)
                                  throws ApiException
```
Build call for restoreApplicant

Parameters:

applicantId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

restoreApplicant
```
public void restoreApplicant(UUID applicantId)
                      throws ApiException
```
Restore Applicant Restores a single applicant scheduled for deletion.

Parameters:

applicantId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

restoreApplicantWithHttpInfo
```
public ApiResponse<Void> restoreApplicantWithHttpInfo(UUID applicantId)
                                               throws ApiException
```
Restore Applicant Restores a single applicant scheduled for deletion.

Parameters:

applicantId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

restoreApplicantAsync
```
public okhttp3.Call restoreApplicantAsync(UUID applicantId,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
```
Restore Applicant (asynchronously) Restores a single applicant scheduled for deletion.

Parameters:

applicantId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeCheckCall
```
public okhttp3.Call resumeCheckCall(UUID checkId,
                                    ApiCallback _callback)
                             throws ApiException
```
Build call for resumeCheck

Parameters:

checkId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeCheck
```
public void resumeCheck(UUID checkId)
                 throws ApiException
```
Resume a Check Resumes a paused check.

Parameters:

checkId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeCheckWithHttpInfo
```
public ApiResponse<Void> resumeCheckWithHttpInfo(UUID checkId)
                                          throws ApiException
```
Resume a Check Resumes a paused check.

Parameters:

checkId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeCheckAsync
```
public okhttp3.Call resumeCheckAsync(UUID checkId,
                                     ApiCallback<Void> _callback)
                              throws ApiException
```
Resume a Check (asynchronously) Resumes a paused check.

Parameters:

checkId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeReportCall
```
public okhttp3.Call resumeReportCall(UUID reportId,
                                     ApiCallback _callback)
                              throws ApiException
```
Build call for resumeReport

Parameters:

reportId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeReport
```
public void resumeReport(UUID reportId)
                  throws ApiException
```
Resume report Resumes a single paused report.

Parameters:

reportId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeReportWithHttpInfo
```
public ApiResponse<Void> resumeReportWithHttpInfo(UUID reportId)
                                           throws ApiException
```
Resume report Resumes a single paused report.

Parameters:

reportId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

resumeReportAsync
```
public okhttp3.Call resumeReportAsync(UUID reportId,
                                      ApiCallback<Void> _callback)
                               throws ApiException
```
Resume report (asynchronously) Resumes a single paused report.

Parameters:

reportId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

204 No Content -

0 Unexpected error -

updateApplicantCall

public okhttp3.Call updateApplicantCall(UUID applicantId,
                                        ApplicantUpdater applicantUpdater,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for updateApplicant

Parameters:

applicantId - (required)

applicantUpdater - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Applicant Object	-
0	Unexpected error	-

updateApplicant
```
public Applicant updateApplicant(UUID applicantId,
                                 ApplicantUpdater applicantUpdater)
                          throws ApiException
```
Update Applicant Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant

Parameters:

applicantId - (required)

applicantUpdater - (required)

Returns:

Applicant

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Applicant Object -

0 Unexpected error -

updateApplicantWithHttpInfo
```
public ApiResponse<Applicant> updateApplicantWithHttpInfo(UUID applicantId,
                                                          ApplicantUpdater applicantUpdater)
                                                   throws ApiException
```
Update Applicant Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant

Parameters:

applicantId - (required)

applicantUpdater - (required)

Returns:

ApiResponse<Applicant>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Applicant Object -

0 Unexpected error -

updateApplicantAsync
```
public okhttp3.Call updateApplicantAsync(UUID applicantId,
                                         ApplicantUpdater applicantUpdater,
                                         ApiCallback<Applicant> _callback)
                                  throws ApiException
```
Update Applicant (asynchronously) Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant

Parameters:

applicantId - (required)

applicantUpdater - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Applicant Object -

0 Unexpected error -

updateWatchlistMonitorMatchCall

public okhttp3.Call updateWatchlistMonitorMatchCall(UUID monitorId,
                                                    WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater,
                                                    ApiCallback _callback)
                                             throws ApiException

Build call for updateWatchlistMonitorMatch

Parameters:

monitorId - (required)

watchlistMonitorMatchesUpdater - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	An array of watchlist monitors	-
0	Unexpected error	-

updateWatchlistMonitorMatch
```
public WatchlistMonitorMatchesList updateWatchlistMonitorMatch(UUID monitorId,
                                                               WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater)
                                                        throws ApiException
```
Set match status (BETA) Update the status of the given matches

Parameters:

monitorId - (required)

watchlistMonitorMatchesUpdater - (required)

Returns:

WatchlistMonitorMatchesList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

0 Unexpected error -

updateWatchlistMonitorMatchWithHttpInfo

public ApiResponse<WatchlistMonitorMatchesList> updateWatchlistMonitorMatchWithHttpInfo(UUID monitorId,
                                                                                        WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater)
                                                                                 throws ApiException

Set match status (BETA) Update the status of the given matches

Parameters:

monitorId - (required)

watchlistMonitorMatchesUpdater - (required)

Returns:

ApiResponse<WatchlistMonitorMatchesList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	An array of watchlist monitors	-
0	Unexpected error	-

updateWatchlistMonitorMatchAsync
```
public okhttp3.Call updateWatchlistMonitorMatchAsync(UUID monitorId,
                                                     WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater,
                                                     ApiCallback<WatchlistMonitorMatchesList> _callback)
                                              throws ApiException
```
Set match status (BETA) (asynchronously) Update the status of the given matches

Parameters:

monitorId - (required)

watchlistMonitorMatchesUpdater - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 An array of watchlist monitors -

0 Unexpected error -

updateWebhookCall
```
public okhttp3.Call updateWebhookCall(UUID webhookId,
                                      WebhookUpdater webhookUpdater,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for updateWebhook

Parameters:

webhookId - (required)

webhookUpdater - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Webhook Object -

0 Unexpected error -

updateWebhook
```
public Webhook updateWebhook(UUID webhookId,
                             WebhookUpdater webhookUpdater)
                      throws ApiException
```
Edit a webhook Edits a webhook. Returns the updated webhook object.

Parameters:

webhookId - (required)

webhookUpdater - (required)

Returns:

Webhook

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Webhook Object -

0 Unexpected error -

updateWebhookWithHttpInfo
```
public ApiResponse<Webhook> updateWebhookWithHttpInfo(UUID webhookId,
                                                      WebhookUpdater webhookUpdater)
                                               throws ApiException
```
Edit a webhook Edits a webhook. Returns the updated webhook object.

Parameters:

webhookId - (required)

webhookUpdater - (required)

Returns:

ApiResponse<Webhook>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Webhook Object -

0 Unexpected error -

updateWebhookAsync
```
public okhttp3.Call updateWebhookAsync(UUID webhookId,
                                       WebhookUpdater webhookUpdater,
                                       ApiCallback<Webhook> _callback)
                                throws ApiException
```
Edit a webhook (asynchronously) Edits a webhook. Returns the updated webhook object.

Parameters:

webhookId - (required)

webhookUpdater - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Webhook Object -

0 Unexpected error -

uploadDocumentCall

public okhttp3.Call uploadDocumentCall(DocumentTypes type,
                                       UUID applicantId,
                                       FileTransfer _file,
                                       String fileType,
                                       String side,
                                       CountryCodes issuingCountry,
                                       Boolean validateImageQuality,
                                       LocationBuilder location,
                                       ApiCallback _callback)
                                throws ApiException

Build call for uploadDocument

Parameters:

type - The type of document (required)

applicantId - The ID of the applicant whose document is being uploaded. (required)

_file - The file to be uploaded. (required)

fileType - The file type of the uploaded file (optional)

side - The side of the document, if applicable. The possible values are front and back (optional)

issuingCountry - The issuing country of the document, a 3-letter ISO code. (optional)

validateImageQuality - Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. (optional)

location - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	A document	-
0	Unexpected error	-

uploadDocument
```
public Document uploadDocument(DocumentTypes type,
                               UUID applicantId,
                               FileTransfer _file,
                               String fileType,
                               String side,
                               CountryCodes issuingCountry,
                               Boolean validateImageQuality,
                               LocationBuilder location)
                        throws ApiException
```
Upload a document Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.

Parameters:

type - The type of document (required)

applicantId - The ID of the applicant whose document is being uploaded. (required)

_file - The file to be uploaded. (required)

fileType - The file type of the uploaded file (optional)

side - The side of the document, if applicable. The possible values are front and back (optional)

issuingCountry - The issuing country of the document, a 3-letter ISO code. (optional)

validateImageQuality - Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. (optional)

location - (optional)

Returns:

Document

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 A document -

0 Unexpected error -

uploadDocumentWithHttpInfo

public ApiResponse<Document> uploadDocumentWithHttpInfo(DocumentTypes type,
                                                        UUID applicantId,
                                                        FileTransfer _file,
                                                        String fileType,
                                                        String side,
                                                        CountryCodes issuingCountry,
                                                        Boolean validateImageQuality,
                                                        LocationBuilder location)
                                                 throws ApiException

Upload a document Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.

Parameters:

type - The type of document (required)

applicantId - The ID of the applicant whose document is being uploaded. (required)

_file - The file to be uploaded. (required)

fileType - The file type of the uploaded file (optional)

side - The side of the document, if applicable. The possible values are front and back (optional)

issuingCountry - The issuing country of the document, a 3-letter ISO code. (optional)

validateImageQuality - Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. (optional)

location - (optional)

Returns:

ApiResponse<Document>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	A document	-
0	Unexpected error	-

uploadDocumentAsync
```
public okhttp3.Call uploadDocumentAsync(DocumentTypes type,
                                        UUID applicantId,
                                        FileTransfer _file,
                                        String fileType,
                                        String side,
                                        CountryCodes issuingCountry,
                                        Boolean validateImageQuality,
                                        LocationBuilder location,
                                        ApiCallback<Document> _callback)
                                 throws ApiException
```
Upload a document (asynchronously) Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.

Parameters:

type - The type of document (required)

applicantId - The ID of the applicant whose document is being uploaded. (required)

_file - The file to be uploaded. (required)

fileType - The file type of the uploaded file (optional)

side - The side of the document, if applicable. The possible values are front and back (optional)

issuingCountry - The issuing country of the document, a 3-letter ISO code. (optional)

validateImageQuality - Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. (optional)

location - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 A document -

0 Unexpected error -

uploadIdPhotoCall
```
public okhttp3.Call uploadIdPhotoCall(UUID applicantId,
                                      FileTransfer _file,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for uploadIdPhoto

Parameters:

applicantId - The ID of the applicant whose ID photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 The ID photo -

0 Unexpected error -

uploadIdPhoto
```
public IdPhoto uploadIdPhoto(UUID applicantId,
                             FileTransfer _file)
                      throws ApiException
```
Upload ID photo You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.

Parameters:

applicantId - The ID of the applicant whose ID photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

Returns:

IdPhoto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 The ID photo -

0 Unexpected error -

uploadIdPhotoWithHttpInfo
```
public ApiResponse<IdPhoto> uploadIdPhotoWithHttpInfo(UUID applicantId,
                                                      FileTransfer _file)
                                               throws ApiException
```
Upload ID photo You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.

Parameters:

applicantId - The ID of the applicant whose ID photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

Returns:

ApiResponse<IdPhoto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 The ID photo -

0 Unexpected error -

uploadIdPhotoAsync
```
public okhttp3.Call uploadIdPhotoAsync(UUID applicantId,
                                       FileTransfer _file,
                                       ApiCallback<IdPhoto> _callback)
                                throws ApiException
```
Upload ID photo (asynchronously) You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.

Parameters:

applicantId - The ID of the applicant whose ID photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 The ID photo -

0 Unexpected error -

uploadLivePhotoCall
```
public okhttp3.Call uploadLivePhotoCall(UUID applicantId,
                                        FileTransfer _file,
                                        Boolean advancedValidation,
                                        ApiCallback _callback)
                                 throws ApiException
```
Build call for uploadLivePhoto

Parameters:

applicantId - The ID of the applicant whose live photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

advancedValidation - Validates that the live photo contains exactly one face. (optional, default to true)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

201 The Live Photo -

0 Unexpected error -

uploadLivePhoto
```
public LivePhoto uploadLivePhoto(UUID applicantId,
                                 FileTransfer _file,
                                 Boolean advancedValidation)
                          throws ApiException
```
Upload live photo You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.

Parameters:

applicantId - The ID of the applicant whose live photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

advancedValidation - Validates that the live photo contains exactly one face. (optional, default to true)

Returns:

LivePhoto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 The Live Photo -

0 Unexpected error -

uploadLivePhotoWithHttpInfo
```
public ApiResponse<LivePhoto> uploadLivePhotoWithHttpInfo(UUID applicantId,
                                                          FileTransfer _file,
                                                          Boolean advancedValidation)
                                                   throws ApiException
```
Upload live photo You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.

Parameters:

applicantId - The ID of the applicant whose live photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

advancedValidation - Validates that the live photo contains exactly one face. (optional, default to true)

Returns:

ApiResponse<LivePhoto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 The Live Photo -

0 Unexpected error -

uploadLivePhotoAsync
```
public okhttp3.Call uploadLivePhotoAsync(UUID applicantId,
                                         FileTransfer _file,
                                         Boolean advancedValidation,
                                         ApiCallback<LivePhoto> _callback)
                                  throws ApiException
```
Upload live photo (asynchronously) You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.

Parameters:

applicantId - The ID of the applicant whose live photo is being uploaded. (optional)

_file - The file to be uploaded. (optional)

advancedValidation - Validates that the live photo contains exactly one face. (optional, default to true)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 The Live Photo -

0 Unexpected error -

Class DefaultApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultApi

DefaultApi

Method Detail

getApiClient

setApiClient

getHostIndex

setHostIndex

getCustomBaseUrl

setCustomBaseUrl

cancelReportCall

cancelReport

cancelReportWithHttpInfo

cancelReportAsync

completeTaskCall

completeTask

completeTaskWithHttpInfo

completeTaskAsync

createApplicantCall

createApplicant

createApplicantWithHttpInfo

createApplicantAsync

createCheckCall

createCheck

createCheckWithHttpInfo

createCheckAsync

createTimelineFileCall

createTimelineFile

createTimelineFileWithHttpInfo

createTimelineFileAsync

createWatchlistMonitorCall

createWatchlistMonitor

createWatchlistMonitorWithHttpInfo

createWatchlistMonitorAsync

createWebhookCall

createWebhook

createWebhookWithHttpInfo

createWebhookAsync

createWorkflowRunCall

createWorkflowRun

createWorkflowRunWithHttpInfo

createWorkflowRunAsync

deleteApplicantCall

deleteApplicant

deleteApplicantWithHttpInfo

deleteApplicantAsync

deleteWatchlistMonitorCall

deleteWatchlistMonitor

deleteWatchlistMonitorWithHttpInfo

deleteWatchlistMonitorAsync

deleteWebhookCall

deleteWebhook

deleteWebhookWithHttpInfo

deleteWebhookAsync

downloadCheckCall

downloadCheck

downloadCheckWithHttpInfo

downloadCheckAsync

downloadDocumentCall

downloadDocument

downloadDocumentWithHttpInfo

downloadDocumentAsync

downloadDocumentVideoCall

downloadDocumentVideo

downloadDocumentVideoWithHttpInfo

downloadDocumentVideoAsync

downloadIdPhotoCall

downloadIdPhoto

downloadIdPhotoWithHttpInfo

downloadIdPhotoAsync

downloadLivePhotoCall

downloadLivePhoto

downloadLivePhotoWithHttpInfo

downloadLivePhotoAsync

downloadLiveVideoCall

downloadLiveVideo