- Kotlin 1.1.2
- Gradle 3.3
First, create the gradle wrapper script:
gradle wrapper
Then, run:
./gradlew check assemble
This runs all tests and packages the library.
- Supports JSON inputs/outputs, File inputs, and Form inputs.
- Supports collection formats for query parameters: csv, tsv, ssv, pipes.
- Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
- Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.
All URIs are relative to https://api.onfido.com/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | cancelReport | POST /checks/{check_id}/reports/{report_id}/cancel | This endpoint is for cancelling individual paused reports. |
| DefaultApi | createApplicant | POST /applicants | Create Applicant |
| DefaultApi | createCheck | POST /applicants/{applicant_id}/checks | Create a check |
| DefaultApi | createWebhook | POST /webhooks | Create a webhook |
| DefaultApi | destroyApplicant | DELETE /applicants/{applicant_id} | Delete Applicant |
| DefaultApi | downloadDocument | GET /applicants/{applicant_id}/documents/{document_id}/download | Download a documents raw data |
| DefaultApi | downloadLivePhoto | GET /live_photos/{live_photo_id}/download | Download live photo |
| DefaultApi | downloadLiveVideo | GET /live_videos/{live_video_id}/download | Download live video |
| DefaultApi | findAddresses | GET /addresses/pick | Search for addresses by postcode |
| DefaultApi | findApplicant | GET /applicants/{applicant_id} | Retrieve Applicant |
| DefaultApi | findCheck | GET /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check |
| DefaultApi | findDocument | GET /applicants/{applicant_id}/documents/{document_id} | A single document can be retrieved by calling this endpoint with the document’s unique identifier. |
| DefaultApi | findLivePhoto | GET /live_photos/{live_photo_id} | Retrieve live photo |
| DefaultApi | findLiveVideo | GET /live_videos/{live_video_id} | Retrieve live video |
| DefaultApi | findReport | GET /checks/{check_id}/reports/{report_id} | A single report can be retrieved using this endpoint with the corresponding unique identifier. |
| DefaultApi | findReportTypeGroup | GET /report_type_groups/{report_type_group_id} | Retrieve single report type group object |
| DefaultApi | findWebhook | GET /webhooks/{webhook_id} | Retrieve a Webhook |
| DefaultApi | listApplicants | GET /applicants | List Applicants |
| DefaultApi | listChecks | GET /applicants/{applicant_id}/checks | Retrieve Checks |
| DefaultApi | listDocuments | GET /applicants/{applicant_id}/documents | List documents |
| DefaultApi | listLivePhotos | GET /live_photos | List live photos |
| DefaultApi | listLiveVideos | GET /live_videos | List live videos |
| DefaultApi | listReportTypeGroups | GET /report_type_groups | Retrieve all report type groups |
| DefaultApi | listReports | GET /checks/{check_id}/reports | All the reports belonging to a particular check can be listed from this endpoint. |
| DefaultApi | listWebhooks | GET /webhooks | List webhooks |
| DefaultApi | restoreApplicant | POST /applicants/{applicant_id}/restore | Restore Applicant |
| DefaultApi | resumeCheck | POST /checks/{check_id}/resume | Resume a Check |
| DefaultApi | resumeReport | POST /checks/{check_id}/reports/{report_id}/resume | This endpoint is for resuming individual paused reports. |
| DefaultApi | updateApplicant | PUT /applicants/{applicant_id} | Update Applicant |
| DefaultApi | uploadDocument | POST /applicants/{applicant_id}/documents | Upload a document |
| DefaultApi | uploadLivePhoto | POST /live_photos | Upload live photo |
- org.openapitools.client.models.Address
- org.openapitools.client.models.Applicant
- org.openapitools.client.models.ApplicantsList
- org.openapitools.client.models.Check
- org.openapitools.client.models.CheckCommon
- org.openapitools.client.models.CheckWithReportIds
- org.openapitools.client.models.ChecksList
- org.openapitools.client.models.Document
- org.openapitools.client.models.DocumentsList
- org.openapitools.client.models.Error
- org.openapitools.client.models.GenericAddress
- org.openapitools.client.models.GenericAddressesList
- org.openapitools.client.models.IdNumber
- org.openapitools.client.models.InlineObject
- org.openapitools.client.models.InlineObject1
- org.openapitools.client.models.LivePhoto
- org.openapitools.client.models.LivePhotosList
- org.openapitools.client.models.LiveVideo
- org.openapitools.client.models.LiveVideosList
- org.openapitools.client.models.Report
- org.openapitools.client.models.ReportDocument
- org.openapitools.client.models.ReportOption
- org.openapitools.client.models.ReportType
- org.openapitools.client.models.ReportTypeGroup
- org.openapitools.client.models.ReportTypeGroupsList
- org.openapitools.client.models.ReportsList
- org.openapitools.client.models.Webhook
- org.openapitools.client.models.WebhooksList
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header