ApiResponse<Void> |
DefaultApi.cancelReportWithHttpInfo(UUID reportId) |
Cancel report
Cancels single paused reports.
|
ApiResponse<Void> |
DefaultApi.completeTaskWithHttpInfo(UUID workflowRunId,
String taskId,
CompleteTaskBuilder completeTaskBuilder) |
Complete Task
Completes a Send / Receive Data Task.
|
ApiResponse<Applicant> |
DefaultApi.createApplicantWithHttpInfo(ApplicantBuilder applicantBuilder) |
Create Applicant
Creates a single applicant.
|
ApiResponse<Check> |
DefaultApi.createCheckWithHttpInfo(CheckBuilder checkBuilder) |
Create a check
Initiates a check for an applicant, which can contain one or more reports.
|
ApiResponse<TimelineFileReference> |
DefaultApi.createTimelineFileWithHttpInfo(UUID workflowRunId) |
Create Timeline File for Workflow Run
Triggers the generation of the Timeline File for the designated Workflow Run.
|
ApiResponse<WatchlistMonitor> |
DefaultApi.createWatchlistMonitorWithHttpInfo(WatchlistMonitorBuilder watchlistMonitorBuilder) |
Create monitor
Creates a new monitor for the applicant
|
ApiResponse<Webhook> |
DefaultApi.createWebhookWithHttpInfo(WebhookBuilder webhookBuilder) |
Register webhook
Registers a webhook.
|
ApiResponse<WorkflowRun> |
DefaultApi.createWorkflowRunWithHttpInfo(WorkflowRunBuilder workflowRunBuilder) |
Create a Workflow Run
Creates and starts a Workflow Run.
|
ApiResponse<Void> |
DefaultApi.deleteApplicantWithHttpInfo(UUID applicantId) |
Delete Applicant
Deletes a single applicant.
|
ApiResponse<Void> |
DefaultApi.deleteWatchlistMonitorWithHttpInfo(UUID monitorId) |
Delete monitor
Deactivates the given monitor
|
ApiResponse<Void> |
DefaultApi.deleteWebhookWithHttpInfo(UUID webhookId) |
Delete a webhook
Deletes a webhook.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadCheckWithHttpInfo(UUID checkId) |
Download check
Downloads a PDF of a check with a given check ID.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadDocumentVideoWithHttpInfo(String documentId) |
Download document video
Downloads a document video.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadDocumentWithHttpInfo(UUID documentId) |
Download document
Downloads specific documents belonging to an applicant.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadIdPhotoWithHttpInfo(UUID idPhotoId) |
Download ID photo
ID photos are downloaded using this endpoint.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadLivePhotoWithHttpInfo(UUID livePhotoId) |
Download live photo
Live photos are downloaded using this endpoint.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadLiveVideoFrameWithHttpInfo(UUID liveVideoId) |
Download live video frame
Returns the binary data representing a single frame from a live video.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadLiveVideoWithHttpInfo(UUID liveVideoId) |
Download live video
Live videos are downloaded using this endpoint.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadMotionCaptureFrameWithHttpInfo(UUID motionCaptureId) |
Download motion capture frame
Instead of the whole capture binary, a single frame can be downloaded using this endpoint.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadMotionCaptureWithHttpInfo(UUID motionCaptureId) |
Download motion capture
Motion captures are downloaded using this endpoint.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadQesDocumentWithHttpInfo(UUID workflowRunId,
UUID fileId) |
Retrieves the signed document or application form
Retrieves the signed document or application form depending on the file_id provided.
|
ApiResponse<FileTransfer> |
DefaultApi.downloadSignedEvidenceFileWithHttpInfo(UUID workflowRunId) |
Retrieve Workflow Run Evidence Summary File
Retrieves the signed evidence file for the designated Workflow Run
|
ApiResponse<Extraction> |
DefaultApi.extractWithHttpInfo(ExtractRequest extractRequest) |
Autofill
Extract information from a document
|
ApiResponse<AddressesList> |
DefaultApi.findAddressesWithHttpInfo(String postcode) |
Address Picker
Search for addresses by postcode
|
ApiResponse<Applicant> |
DefaultApi.findApplicantWithHttpInfo(UUID applicantId) |
Retrieve Applicant
Retrieves a single applicant.
|
ApiResponse<Check> |
DefaultApi.findCheckWithHttpInfo(UUID checkId) |
Retrieve a Check
Retrieves a single check.
|
ApiResponse<Document> |
DefaultApi.findDocumentWithHttpInfo(UUID documentId) |
Retrieve document
A single document can be retrieved by calling this endpoint with the document's unique identifier.
|
ApiResponse<IdPhoto> |
DefaultApi.findIdPhotoWithHttpInfo(UUID idPhotoId) |
Retrieve ID photo
Retrieves a single ID photo.
|
ApiResponse<LivePhoto> |
DefaultApi.findLivePhotoWithHttpInfo(UUID livePhotoId) |
Retrieve live photo
Retrieves a single live photo.
|
ApiResponse<LiveVideo> |
DefaultApi.findLiveVideoWithHttpInfo(UUID liveVideoId) |
Retrieve live video
Retrieves a single live video.
|
ApiResponse<MotionCapture> |
DefaultApi.findMotionCaptureWithHttpInfo(UUID motionCaptureId) |
Retrieve motion capture
Retrieves a single motion capture.
|
ApiResponse<Report> |
DefaultApi.findReportWithHttpInfo(UUID reportId) |
Retrieve report
A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
ApiResponse<Task> |
DefaultApi.findTaskWithHttpInfo(UUID workflowRunId,
String taskId) |
Retrieve Task
A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
ApiResponse<FileTransfer> |
DefaultApi.findTimelineFileWithHttpInfo(UUID workflowRunId,
UUID timelineFileId) |
Retrieve Timeline File for Workflow Run
Retrieves the Timeline File for the designated Workflow Run.
|
ApiResponse<WatchlistMonitor> |
DefaultApi.findWatchlistMonitorWithHttpInfo(UUID monitorId) |
Retrieve monitor
Retrieves a single monitor
|
ApiResponse<Webhook> |
DefaultApi.findWebhookWithHttpInfo(UUID webhookId) |
Retrieve a Webhook
Retrieves a single webhook.
|
ApiResponse<WorkflowRun> |
DefaultApi.findWorkflowRunWithHttpInfo(UUID workflowRunId) |
Retrieve Workflow Run
A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
ApiResponse<Void> |
DefaultApi.forceReportCreationFromWatchlistMonitorWithHttpInfo(UUID monitorId) |
Force new report creation (BETA)
Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
ApiResponse<SdkToken> |
DefaultApi.generateSdkTokenWithHttpInfo(SdkTokenBuilder sdkTokenBuilder) |
Generate a SDK token
Generates an SDK token.
|
ApiResponse<ApplicantsList> |
DefaultApi.listApplicantsWithHttpInfo(Integer page,
Integer perPage,
Boolean includeDeleted) |
List Applicants
Lists all applicants you've created, sorted by creation date in descending order.
|
ApiResponse<ChecksList> |
DefaultApi.listChecksWithHttpInfo(UUID applicantId) |
Retrieve Checks
Retrieves a single check.
|
ApiResponse<DocumentsList> |
DefaultApi.listDocumentsWithHttpInfo(UUID applicantId) |
List documents
All documents belonging to an applicant can be listed from this endpoint
|
ApiResponse<IdPhotosList> |
DefaultApi.listIdPhotosWithHttpInfo(UUID applicantId) |
List ID photos
Lists the ID photos that belong to an applicant.
|
ApiResponse<LivePhotosList> |
DefaultApi.listLivePhotosWithHttpInfo(UUID applicantId) |
List live photos
Lists the live photos that belong to an applicant.
|
ApiResponse<LiveVideosList> |
DefaultApi.listLiveVideosWithHttpInfo(UUID applicantId) |
List live videos
Lists all the live videos that belong to an applicant.
|
ApiResponse<MotionCapturesList> |
DefaultApi.listMotionCapturesWithHttpInfo(UUID applicantId) |
List motion captures
Lists all the motion captures that belong to an applicant.
|
ApiResponse<RepeatAttemptsList> |
DefaultApi.listRepeatAttemptsWithHttpInfo(UUID reportId) |
Retrieve repeat attempts
Returns all repeat attempts for a given Document report
|
ApiResponse<ReportsList> |
DefaultApi.listReportsWithHttpInfo(UUID checkId) |
List reports
All the reports belonging to a particular check can be listed from this endpoint.
|
ApiResponse<List<TaskItem>> |
DefaultApi.listTasksWithHttpInfo(UUID workflowRunId) |
List Tasks
The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
ApiResponse<WatchlistMonitorMatchesList> |
DefaultApi.listWatchlistMonitorMatchesWithHttpInfo(UUID monitorId) |
List matches (BETA)
List match IDs on this monitor, as well as their enabled/disabled status
|
ApiResponse<WatchlistMonitorsList> |
DefaultApi.listWatchlistMonitorsWithHttpInfo(UUID applicantId,
Boolean includeDeleted) |
List monitors
List all available monitors for an applicant
|
ApiResponse<WebhooksList> |
DefaultApi.listWebhooksWithHttpInfo() |
List webhooks
Lists all webhooks you've created.
|
ApiResponse<List<WorkflowRun>> |
DefaultApi.listWorkflowRunsWithHttpInfo(Integer page,
String status,
OffsetDateTime createdAtGt,
OffsetDateTime createdAtLt,
String sort) |
List Workflow Runs
Retrieves the Workflow Runs of the client.
|
ApiResponse<String> |
DefaultApi.pingWithHttpInfo() |
Ping
Run a health check on the Onfido API
|
ApiResponse<ResultsFeedback> |
DefaultApi.postResultsFeedbackWithHttpInfo(ResultsFeedback resultsFeedback) |
Fraud reporting (ALPHA)
Create Feedback on checks and reports
|
ApiResponse<Void> |
DefaultApi.resendWebhooksWithHttpInfo(WebhookResend webhookResend) |
Resends webhooks
Resends events to all webhooks registered with a matching environment in your account.
|
ApiResponse<Void> |
DefaultApi.restoreApplicantWithHttpInfo(UUID applicantId) |
Restore Applicant
Restores a single applicant scheduled for deletion.
|
ApiResponse<Void> |
DefaultApi.resumeCheckWithHttpInfo(UUID checkId) |
Resume a Check
Resumes a paused check.
|
ApiResponse<Void> |
DefaultApi.resumeReportWithHttpInfo(UUID reportId) |
Resume report
Resumes a single paused report.
|
ApiResponse<Applicant> |
DefaultApi.updateApplicantWithHttpInfo(UUID applicantId,
ApplicantUpdater applicantUpdater) |
Update Applicant
Allows updating applicant's information before any checks is created.
|
ApiResponse<WatchlistMonitorMatchesList> |
DefaultApi.updateWatchlistMonitorMatchWithHttpInfo(UUID monitorId,
WatchlistMonitorMatchesUpdater watchlistMonitorMatchesUpdater) |
Set match status (BETA)
Update the status of the given matches
|
ApiResponse<Webhook> |
DefaultApi.updateWebhookWithHttpInfo(UUID webhookId,
WebhookUpdater webhookUpdater) |
Edit a webhook
Edits a webhook.
|
ApiResponse<Document> |
DefaultApi.uploadDocumentWithHttpInfo(DocumentTypes type,
UUID applicantId,
FileTransfer _file,
String fileType,
String side,
CountryCodes issuingCountry,
Boolean validateImageQuality,
LocationBuilder location) |
Upload a document
Documents are uploaded using this endpoint.
|
ApiResponse<IdPhoto> |
DefaultApi.uploadIdPhotoWithHttpInfo(UUID applicantId,
FileTransfer _file) |
Upload ID photo
You can upload ID photos to this endpoint.
|
ApiResponse<LivePhoto> |
DefaultApi.uploadLivePhotoWithHttpInfo(UUID applicantId,
FileTransfer _file,
Boolean advancedValidation) |
Upload live photo
You can upload live photos to this endpoint.
|