Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/dhia-gharsallaoui/go-onfido

Golang client for the Onfido API
https://github.com/dhia-gharsallaoui/go-onfido
go golang onfido openapi swagger
Last synced: about 1 month ago
JSON representation
Golang client for the Onfido API
Host: GitHub
URL: https://github.com/dhia-gharsallaoui/go-onfido
Owner: dhia-gharsallaoui
Created: 2024-09-13T08:52:23.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-09-16T17:30:14.000Z (2 months ago)
Last Synced: 2024-10-02T07:42:15.456Z (about 1 month ago)
Topics: go, golang, onfido, openapi, swagger
Language: Shell
Homepage:
Size: 490 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # Go API client for openapi

The Onfido API (v3.6)

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: v3.6

- Package version: 1.0.0

- Generator version: 7.9.0-SNAPSHOT

- Build package: org.openapitools.codegen.languages.GoClientCodegen

For more information, please visit [https://public.support.onfido.com](https://public.support.onfido.com)

## Installation

Install the following dependencies:

```sh

go get github.com/stretchr/testify/assert

go get golang.org/x/net/context

```

Put the package under your project folder and add the following in import:

```go

import openapi "github.com/dhia-gharsallaoui/go-onfido"

```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `openapi.ContextServerIndex` of type `int`.

```go

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `openapi.ContextServerVariables` of type `map[string]string`.

```go

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{

	"basePath": "v2",

})

```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.

An operation is uniquely identified by `"{classname}Service.{nickname}"` string.

Similar rules for overriding default operation server index and variables applies by using `openapi.ContextOperationServerIndices` and `openapi.ContextOperationServerVariables` context maps.

```go

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{

	"{classname}Service.{nickname}": 2,

})

ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{

	"{classname}Service.{nickname}": {

		"port": "8443",

	},

})

```

## Documentation for API Endpoints

All URIs are relative to *https://api.eu.onfido.com/v3.6*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*DefaultAPI* | [**CancelReport**](docs/DefaultAPI.md#cancelreport) | **Post** /reports/{report_id}/cancel | Cancel report

*DefaultAPI* | [**CompleteTask**](docs/DefaultAPI.md#completetask) | **Post** /workflow_runs/{workflow_run_id}/tasks/{task_id}/complete | Complete Task

*DefaultAPI* | [**CreateApplicant**](docs/DefaultAPI.md#createapplicant) | **Post** /applicants | Create Applicant

*DefaultAPI* | [**CreateCheck**](docs/DefaultAPI.md#createcheck) | **Post** /checks | Create a check

*DefaultAPI* | [**CreateTimelineFile**](docs/DefaultAPI.md#createtimelinefile) | **Post** /workflow_runs/{workflow_run_id}/timeline_file | Create Timeline File for Workflow Run

*DefaultAPI* | [**CreateWatchlistMonitor**](docs/DefaultAPI.md#createwatchlistmonitor) | **Post** /watchlist_monitors | Create monitor

*DefaultAPI* | [**CreateWebhook**](docs/DefaultAPI.md#createwebhook) | **Post** /webhooks | Register webhook

*DefaultAPI* | [**CreateWorkflowRun**](docs/DefaultAPI.md#createworkflowrun) | **Post** /workflow_runs | Create a Workflow Run

*DefaultAPI* | [**DeleteApplicant**](docs/DefaultAPI.md#deleteapplicant) | **Delete** /applicants/{applicant_id} | Delete Applicant

*DefaultAPI* | [**DeleteWatchlistMonitor**](docs/DefaultAPI.md#deletewatchlistmonitor) | **Delete** /watchlist_monitors/{monitor_id} | Delete monitor

*DefaultAPI* | [**DeleteWebhook**](docs/DefaultAPI.md#deletewebhook) | **Delete** /webhooks/{webhook_id} | Delete a webhook

*DefaultAPI* | [**DownloadCheck**](docs/DefaultAPI.md#downloadcheck) | **Get** /checks/{check_id}/download | Download check

*DefaultAPI* | [**DownloadDocument**](docs/DefaultAPI.md#downloaddocument) | **Get** /documents/{document_id}/download | Download document

*DefaultAPI* | [**DownloadDocumentVideo**](docs/DefaultAPI.md#downloaddocumentvideo) | **Get** /documents/{document_id}/video/download | Download document video

*DefaultAPI* | [**DownloadIdPhoto**](docs/DefaultAPI.md#downloadidphoto) | **Get** /id_photos/{id_photo_id}/download | Download ID photo

*DefaultAPI* | [**DownloadLivePhoto**](docs/DefaultAPI.md#downloadlivephoto) | **Get** /live_photos/{live_photo_id}/download | Download live photo

*DefaultAPI* | [**DownloadLiveVideo**](docs/DefaultAPI.md#downloadlivevideo) | **Get** /live_videos/{live_video_id}/download | Download live video

*DefaultAPI* | [**DownloadLiveVideoFrame**](docs/DefaultAPI.md#downloadlivevideoframe) | **Get** /live_videos/{live_video_id}/frame | Download live video frame

*DefaultAPI* | [**DownloadMotionCapture**](docs/DefaultAPI.md#downloadmotioncapture) | **Get** /motion_captures/{motion_capture_id}/download | Download motion capture

*DefaultAPI* | [**DownloadMotionCaptureFrame**](docs/DefaultAPI.md#downloadmotioncaptureframe) | **Get** /motion_captures/{motion_capture_id}/frame | Download motion capture frame

*DefaultAPI* | [**DownloadQesDocument**](docs/DefaultAPI.md#downloadqesdocument) | **Get** /qualified_electronic_signature/documents | Retrieves the signed document or application form

*DefaultAPI* | [**DownloadSignedEvidenceFile**](docs/DefaultAPI.md#downloadsignedevidencefile) | **Get** /workflow_runs/{workflow_run_id}/signed_evidence_file | Retrieve Workflow Run Evidence Summary File

*DefaultAPI* | [**Extract**](docs/DefaultAPI.md#extract) | **Post** /extractions | Autofill

*DefaultAPI* | [**FindAddresses**](docs/DefaultAPI.md#findaddresses) | **Get** /addresses/pick | Address Picker

*DefaultAPI* | [**FindApplicant**](docs/DefaultAPI.md#findapplicant) | **Get** /applicants/{applicant_id} | Retrieve Applicant

*DefaultAPI* | [**FindCheck**](docs/DefaultAPI.md#findcheck) | **Get** /checks/{check_id} | Retrieve a Check

*DefaultAPI* | [**FindDocument**](docs/DefaultAPI.md#finddocument) | **Get** /documents/{document_id} | Retrieve document

*DefaultAPI* | [**FindIdPhoto**](docs/DefaultAPI.md#findidphoto) | **Get** /id_photos/{id_photo_id} | Retrieve ID photo

*DefaultAPI* | [**FindLivePhoto**](docs/DefaultAPI.md#findlivephoto) | **Get** /live_photos/{live_photo_id} | Retrieve live photo

*DefaultAPI* | [**FindLiveVideo**](docs/DefaultAPI.md#findlivevideo) | **Get** /live_videos/{live_video_id} | Retrieve live video

*DefaultAPI* | [**FindMotionCapture**](docs/DefaultAPI.md#findmotioncapture) | **Get** /motion_captures/{motion_capture_id} | Retrieve motion capture

*DefaultAPI* | [**FindReport**](docs/DefaultAPI.md#findreport) | **Get** /reports/{report_id} | Retrieve report

*DefaultAPI* | [**FindTask**](docs/DefaultAPI.md#findtask) | **Get** /workflow_runs/{workflow_run_id}/tasks/{task_id} | Retrieve Task

*DefaultAPI* | [**FindTimelineFile**](docs/DefaultAPI.md#findtimelinefile) | **Get** /workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id} | Retrieve Timeline File for Workflow Run

*DefaultAPI* | [**FindWatchlistMonitor**](docs/DefaultAPI.md#findwatchlistmonitor) | **Get** /watchlist_monitors/{monitor_id} | Retrieve monitor

*DefaultAPI* | [**FindWebhook**](docs/DefaultAPI.md#findwebhook) | **Get** /webhooks/{webhook_id} | Retrieve a Webhook

*DefaultAPI* | [**FindWorkflowRun**](docs/DefaultAPI.md#findworkflowrun) | **Get** /workflow_runs/{workflow_run_id} | Retrieve Workflow Run

*DefaultAPI* | [**ForceReportCreationFromWatchlistMonitor**](docs/DefaultAPI.md#forcereportcreationfromwatchlistmonitor) | **Post** /watchlist_monitors/{monitor_id}/new_report | Force new report creation (BETA)

*DefaultAPI* | [**GenerateSdkToken**](docs/DefaultAPI.md#generatesdktoken) | **Post** /sdk_token | Generate a SDK token

*DefaultAPI* | [**ListApplicants**](docs/DefaultAPI.md#listapplicants) | **Get** /applicants | List Applicants

*DefaultAPI* | [**ListChecks**](docs/DefaultAPI.md#listchecks) | **Get** /checks | Retrieve Checks

*DefaultAPI* | [**ListDocuments**](docs/DefaultAPI.md#listdocuments) | **Get** /documents | List documents

*DefaultAPI* | [**ListIdPhotos**](docs/DefaultAPI.md#listidphotos) | **Get** /id_photos | List ID photos

*DefaultAPI* | [**ListLivePhotos**](docs/DefaultAPI.md#listlivephotos) | **Get** /live_photos | List live photos

*DefaultAPI* | [**ListLiveVideos**](docs/DefaultAPI.md#listlivevideos) | **Get** /live_videos | List live videos

*DefaultAPI* | [**ListMotionCaptures**](docs/DefaultAPI.md#listmotioncaptures) | **Get** /motion_captures | List motion captures

*DefaultAPI* | [**ListRepeatAttempts**](docs/DefaultAPI.md#listrepeatattempts) | **Get** /repeat_attempts/{report_id} | Retrieve repeat attempts

*DefaultAPI* | [**ListReports**](docs/DefaultAPI.md#listreports) | **Get** /reports | List reports

*DefaultAPI* | [**ListTasks**](docs/DefaultAPI.md#listtasks) | **Get** /workflow_runs/{workflow_run_id}/tasks | List Tasks

*DefaultAPI* | [**ListWatchlistMonitorMatches**](docs/DefaultAPI.md#listwatchlistmonitormatches) | **Get** /watchlist_monitors/{monitor_id}/matches | List matches (BETA)

*DefaultAPI* | [**ListWatchlistMonitors**](docs/DefaultAPI.md#listwatchlistmonitors) | **Get** /watchlist_monitors | List monitors

*DefaultAPI* | [**ListWebhooks**](docs/DefaultAPI.md#listwebhooks) | **Get** /webhooks | List webhooks

*DefaultAPI* | [**ListWorkflowRuns**](docs/DefaultAPI.md#listworkflowruns) | **Get** /workflow_runs | List Workflow Runs

*DefaultAPI* | [**Ping**](docs/DefaultAPI.md#ping) | **Get** /ping | Ping

*DefaultAPI* | [**PostResultsFeedback**](docs/DefaultAPI.md#postresultsfeedback) | **Post** /results_feedback | Fraud reporting (ALPHA)

*DefaultAPI* | [**ResendWebhooks**](docs/DefaultAPI.md#resendwebhooks) | **Post** /webhooks/resend | Resends webhooks

*DefaultAPI* | [**RestoreApplicant**](docs/DefaultAPI.md#restoreapplicant) | **Post** /applicants/{applicant_id}/restore | Restore Applicant

*DefaultAPI* | [**ResumeCheck**](docs/DefaultAPI.md#resumecheck) | **Post** /checks/{check_id}/resume | Resume a Check

*DefaultAPI* | [**ResumeReport**](docs/DefaultAPI.md#resumereport) | **Post** /reports/{report_id}/resume | Resume report

*DefaultAPI* | [**UpdateApplicant**](docs/DefaultAPI.md#updateapplicant) | **Put** /applicants/{applicant_id} | Update Applicant

*DefaultAPI* | [**UpdateWatchlistMonitorMatch**](docs/DefaultAPI.md#updatewatchlistmonitormatch) | **Patch** /watchlist_monitors/{monitor_id}/matches | Set match status (BETA)

*DefaultAPI* | [**UpdateWebhook**](docs/DefaultAPI.md#updatewebhook) | **Put** /webhooks/{webhook_id} | Edit a webhook

*DefaultAPI* | [**UploadDocument**](docs/DefaultAPI.md#uploaddocument) | **Post** /documents | Upload a document

*DefaultAPI* | [**UploadIdPhoto**](docs/DefaultAPI.md#uploadidphoto) | **Post** /id_photos | Upload ID photo

*DefaultAPI* | [**UploadLivePhoto**](docs/DefaultAPI.md#uploadlivephoto) | **Post** /live_photos | Upload live photo

## Documentation For Models

 - [Address](docs/Address.md)

 - [AddressBuilder](docs/AddressBuilder.md)

 - [AddressShared](docs/AddressShared.md)

 - [AddressesList](docs/AddressesList.md)

 - [Applicant](docs/Applicant.md)

 - [ApplicantBuilder](docs/ApplicantBuilder.md)

 - [ApplicantCreate](docs/ApplicantCreate.md)

 - [ApplicantRequest](docs/ApplicantRequest.md)

 - [ApplicantResponse](docs/ApplicantResponse.md)

 - [ApplicantShared](docs/ApplicantShared.md)

 - [ApplicantUpdate](docs/ApplicantUpdate.md)

 - [ApplicantUpdater](docs/ApplicantUpdater.md)

 - [ApplicantsList](docs/ApplicantsList.md)

 - [Check](docs/Check.md)

 - [CheckBuilder](docs/CheckBuilder.md)

 - [CheckRequest](docs/CheckRequest.md)

 - [CheckResponse](docs/CheckResponse.md)

 - [CheckShared](docs/CheckShared.md)

 - [ChecksList](docs/ChecksList.md)

 - [CompleteTaskBuilder](docs/CompleteTaskBuilder.md)

 - [CompleteTaskDataBuilder](docs/CompleteTaskDataBuilder.md)

 - [ConsentItem](docs/ConsentItem.md)

 - [ConsentsBuilder](docs/ConsentsBuilder.md)

 - [CountryCodes](docs/CountryCodes.md)

 - [DeviceIntelligenceBreakdown](docs/DeviceIntelligenceBreakdown.md)

 - [DeviceIntelligenceBreakdownBreakdown](docs/DeviceIntelligenceBreakdownBreakdown.md)

 - [DeviceIntelligenceBreakdownBreakdownDevice](docs/DeviceIntelligenceBreakdownBreakdownDevice.md)

 - [DeviceIntelligenceBreakdownBreakdownDeviceBreakdown](docs/DeviceIntelligenceBreakdownBreakdownDeviceBreakdown.md)

 - [DeviceIntelligenceBreakdownProperties](docs/DeviceIntelligenceBreakdownProperties.md)

 - [DeviceIntelligenceBreakdownPropertiesDevice](docs/DeviceIntelligenceBreakdownPropertiesDevice.md)

 - [DeviceIntelligenceBreakdownPropertiesGeolocation](docs/DeviceIntelligenceBreakdownPropertiesGeolocation.md)

 - [DeviceIntelligenceBreakdownPropertiesIp](docs/DeviceIntelligenceBreakdownPropertiesIp.md)

 - [DeviceIntelligenceReport](docs/DeviceIntelligenceReport.md)

 - [Document](docs/Document.md)

 - [DocumentBreakdown](docs/DocumentBreakdown.md)

 - [DocumentBreakdownAgeValidation](docs/DocumentBreakdownAgeValidation.md)

 - [DocumentBreakdownAgeValidationBreakdown](docs/DocumentBreakdownAgeValidationBreakdown.md)

 - [DocumentBreakdownCompromisedDocument](docs/DocumentBreakdownCompromisedDocument.md)

 - [DocumentBreakdownCompromisedDocumentBreakdown](docs/DocumentBreakdownCompromisedDocumentBreakdown.md)

 - [DocumentBreakdownDataComparison](docs/DocumentBreakdownDataComparison.md)

 - [DocumentBreakdownDataComparisonBreakdown](docs/DocumentBreakdownDataComparisonBreakdown.md)

 - [DocumentBreakdownDataComparisonBreakdownIssuingCountry](docs/DocumentBreakdownDataComparisonBreakdownIssuingCountry.md)

 - [DocumentBreakdownDataConsistency](docs/DocumentBreakdownDataConsistency.md)

 - [DocumentBreakdownDataConsistencyBreakdown](docs/DocumentBreakdownDataConsistencyBreakdown.md)

 - [DocumentBreakdownDataValidation](docs/DocumentBreakdownDataValidation.md)

 - [DocumentBreakdownDataValidationBreakdown](docs/DocumentBreakdownDataValidationBreakdown.md)

 - [DocumentBreakdownDataValidationBreakdownDocumentExpiration](docs/DocumentBreakdownDataValidationBreakdownDocumentExpiration.md)

 - [DocumentBreakdownDataValidationBreakdownExpiryDate](docs/DocumentBreakdownDataValidationBreakdownExpiryDate.md)

 - [DocumentBreakdownImageIntegrity](docs/DocumentBreakdownImageIntegrity.md)

 - [DocumentBreakdownImageIntegrityBreakdown](docs/DocumentBreakdownImageIntegrityBreakdown.md)

 - [DocumentBreakdownImageIntegrityBreakdownColourPicture](docs/DocumentBreakdownImageIntegrityBreakdownColourPicture.md)

 - [DocumentBreakdownImageIntegrityBreakdownConclusiveDocumentQuality](docs/DocumentBreakdownImageIntegrityBreakdownConclusiveDocumentQuality.md)

 - [DocumentBreakdownImageIntegrityBreakdownImageQuality](docs/DocumentBreakdownImageIntegrityBreakdownImageQuality.md)

 - [DocumentBreakdownImageIntegrityBreakdownSupportedDocument](docs/DocumentBreakdownImageIntegrityBreakdownSupportedDocument.md)

 - [DocumentBreakdownIssuingAuthority](docs/DocumentBreakdownIssuingAuthority.md)

 - [DocumentBreakdownIssuingAuthorityBreakdown](docs/DocumentBreakdownIssuingAuthorityBreakdown.md)

 - [DocumentBreakdownIssuingAuthorityBreakdownNfcActiveAuthentication](docs/DocumentBreakdownIssuingAuthorityBreakdownNfcActiveAuthentication.md)

 - [DocumentBreakdownIssuingAuthorityBreakdownNfcPassiveAuthentication](docs/DocumentBreakdownIssuingAuthorityBreakdownNfcPassiveAuthentication.md)

 - [DocumentBreakdownPoliceRecord](docs/DocumentBreakdownPoliceRecord.md)

 - [DocumentBreakdownVisualAuthenticity](docs/DocumentBreakdownVisualAuthenticity.md)

 - [DocumentBreakdownVisualAuthenticityBreakdown](docs/DocumentBreakdownVisualAuthenticityBreakdown.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownDigitalTampering](docs/DocumentBreakdownVisualAuthenticityBreakdownDigitalTampering.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownFaceDetection](docs/DocumentBreakdownVisualAuthenticityBreakdownFaceDetection.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownFonts](docs/DocumentBreakdownVisualAuthenticityBreakdownFonts.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownOriginalDocumentPresent](docs/DocumentBreakdownVisualAuthenticityBreakdownOriginalDocumentPresent.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownOther](docs/DocumentBreakdownVisualAuthenticityBreakdownOther.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownPictureFaceIntegrity](docs/DocumentBreakdownVisualAuthenticityBreakdownPictureFaceIntegrity.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownSecurityFeatures](docs/DocumentBreakdownVisualAuthenticityBreakdownSecurityFeatures.md)

 - [DocumentBreakdownVisualAuthenticityBreakdownTemplate](docs/DocumentBreakdownVisualAuthenticityBreakdownTemplate.md)

 - [DocumentCDQReasons](docs/DocumentCDQReasons.md)

 - [DocumentIQReasons](docs/DocumentIQReasons.md)

 - [DocumentODPReasons](docs/DocumentODPReasons.md)

 - [DocumentProperties](docs/DocumentProperties.md)

 - [DocumentPropertiesAddressLines](docs/DocumentPropertiesAddressLines.md)

 - [DocumentPropertiesBarcodeInner](docs/DocumentPropertiesBarcodeInner.md)

 - [DocumentPropertiesDocumentClassification](docs/DocumentPropertiesDocumentClassification.md)

 - [DocumentPropertiesDocumentNumbersInner](docs/DocumentPropertiesDocumentNumbersInner.md)

 - [DocumentPropertiesDrivingLicenceInformation](docs/DocumentPropertiesDrivingLicenceInformation.md)

 - [DocumentPropertiesExtractedData](docs/DocumentPropertiesExtractedData.md)

 - [DocumentPropertiesNfc](docs/DocumentPropertiesNfc.md)

 - [DocumentReport](docs/DocumentReport.md)

 - [DocumentResponse](docs/DocumentResponse.md)

 - [DocumentShared](docs/DocumentShared.md)

 - [DocumentTypes](docs/DocumentTypes.md)

 - [DocumentVideoReport](docs/DocumentVideoReport.md)

 - [DocumentVideoWithAddressInformationReport](docs/DocumentVideoWithAddressInformationReport.md)

 - [DocumentWithAddressInformationReport](docs/DocumentWithAddressInformationReport.md)

 - [DocumentWithDriverVerificationReport](docs/DocumentWithDriverVerificationReport.md)

 - [DocumentWithDriverVerificationReportAllOfProperties](docs/DocumentWithDriverVerificationReportAllOfProperties.md)

 - [DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle](docs/DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle.md)

 - [DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner](docs/DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner.md)

 - [DocumentWithDrivingLicenceInformationReport](docs/DocumentWithDrivingLicenceInformationReport.md)

 - [DocumentsList](docs/DocumentsList.md)

 - [Error](docs/Error.md)

 - [Error1](docs/Error1.md)

 - [ErrorProperties](docs/ErrorProperties.md)

 - [ErrorProperties1](docs/ErrorProperties1.md)

 - [ExtractRequest](docs/ExtractRequest.md)

 - [Extraction](docs/Extraction.md)

 - [ExtractionDocumentClassification](docs/ExtractionDocumentClassification.md)

 - [ExtractionExtractedData](docs/ExtractionExtractedData.md)

 - [FacialSimilarityMotionBreakdown](docs/FacialSimilarityMotionBreakdown.md)

 - [FacialSimilarityMotionBreakdownFaceComparison](docs/FacialSimilarityMotionBreakdownFaceComparison.md)

 - [FacialSimilarityMotionBreakdownImageIntegrity](docs/FacialSimilarityMotionBreakdownImageIntegrity.md)

 - [FacialSimilarityMotionBreakdownImageIntegrityBreakdown](docs/FacialSimilarityMotionBreakdownImageIntegrityBreakdown.md)

 - [FacialSimilarityMotionBreakdownImageIntegrityBreakdownFaceDetected](docs/FacialSimilarityMotionBreakdownImageIntegrityBreakdownFaceDetected.md)

 - [FacialSimilarityMotionBreakdownImageIntegrityBreakdownSourceIntegrity](docs/FacialSimilarityMotionBreakdownImageIntegrityBreakdownSourceIntegrity.md)

 - [FacialSimilarityMotionBreakdownVisualAuthenticity](docs/FacialSimilarityMotionBreakdownVisualAuthenticity.md)

 - [FacialSimilarityMotionBreakdownVisualAuthenticityBreakdown](docs/FacialSimilarityMotionBreakdownVisualAuthenticityBreakdown.md)

 - [FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoofingDetection](docs/FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoofingDetection.md)

 - [FacialSimilarityMotionProperties](docs/FacialSimilarityMotionProperties.md)

 - [FacialSimilarityMotionReport](docs/FacialSimilarityMotionReport.md)

 - [FacialSimilarityPhotoBreakdown](docs/FacialSimilarityPhotoBreakdown.md)

 - [FacialSimilarityPhotoBreakdownFaceComparison](docs/FacialSimilarityPhotoBreakdownFaceComparison.md)

 - [FacialSimilarityPhotoBreakdownFaceComparisonBreakdown](docs/FacialSimilarityPhotoBreakdownFaceComparisonBreakdown.md)

 - [FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatch](docs/FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatch.md)

 - [FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties](docs/FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties.md)

 - [FacialSimilarityPhotoBreakdownImageIntegrity](docs/FacialSimilarityPhotoBreakdownImageIntegrity.md)

 - [FacialSimilarityPhotoBreakdownImageIntegrityBreakdown](docs/FacialSimilarityPhotoBreakdownImageIntegrityBreakdown.md)

 - [FacialSimilarityPhotoBreakdownImageIntegrityBreakdownFaceDetected](docs/FacialSimilarityPhotoBreakdownImageIntegrityBreakdownFaceDetected.md)

 - [FacialSimilarityPhotoBreakdownImageIntegrityBreakdownSourceIntegrity](docs/FacialSimilarityPhotoBreakdownImageIntegrityBreakdownSourceIntegrity.md)

 - [FacialSimilarityPhotoBreakdownVisualAuthenticity](docs/FacialSimilarityPhotoBreakdownVisualAuthenticity.md)

 - [FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdown](docs/FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdown.md)

 - [FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetection](docs/FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetection.md)

 - [FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties](docs/FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties.md)

 - [FacialSimilarityPhotoFullyAutoBreakdown](docs/FacialSimilarityPhotoFullyAutoBreakdown.md)

 - [FacialSimilarityPhotoFullyAutoBreakdownImageIntegrity](docs/FacialSimilarityPhotoFullyAutoBreakdownImageIntegrity.md)

 - [FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdown](docs/FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdown.md)

 - [FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownSourceIntegrity](docs/FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownSourceIntegrity.md)

 - [FacialSimilarityPhotoFullyAutoProperties](docs/FacialSimilarityPhotoFullyAutoProperties.md)

 - [FacialSimilarityPhotoFullyAutoReport](docs/FacialSimilarityPhotoFullyAutoReport.md)

 - [FacialSimilarityPhotoProperties](docs/FacialSimilarityPhotoProperties.md)

 - [FacialSimilarityPhotoReport](docs/FacialSimilarityPhotoReport.md)

 - [FacialSimilarityVideoBreakdown](docs/FacialSimilarityVideoBreakdown.md)

 - [FacialSimilarityVideoBreakdownFaceComparison](docs/FacialSimilarityVideoBreakdownFaceComparison.md)

 - [FacialSimilarityVideoBreakdownImageIntegrity](docs/FacialSimilarityVideoBreakdownImageIntegrity.md)

 - [FacialSimilarityVideoBreakdownImageIntegrityBreakdown](docs/FacialSimilarityVideoBreakdownImageIntegrityBreakdown.md)

 - [FacialSimilarityVideoBreakdownImageIntegrityBreakdownFaceDetected](docs/FacialSimilarityVideoBreakdownImageIntegrityBreakdownFaceDetected.md)

 - [FacialSimilarityVideoBreakdownImageIntegrityBreakdownSourceIntegrity](docs/FacialSimilarityVideoBreakdownImageIntegrityBreakdownSourceIntegrity.md)

 - [FacialSimilarityVideoBreakdownVisualAuthenticity](docs/FacialSimilarityVideoBreakdownVisualAuthenticity.md)

 - [FacialSimilarityVideoBreakdownVisualAuthenticityBreakdown](docs/FacialSimilarityVideoBreakdownVisualAuthenticityBreakdown.md)

 - [FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownLivenessDetected](docs/FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownLivenessDetected.md)

 - [FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofingDetection](docs/FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofingDetection.md)

 - [FacialSimilarityVideoProperties](docs/FacialSimilarityVideoProperties.md)

 - [FacialSimilarityVideoReport](docs/FacialSimilarityVideoReport.md)

 - [IdNumber](docs/IdNumber.md)

 - [IdPhoto](docs/IdPhoto.md)

 - [IdPhotoResponse](docs/IdPhotoResponse.md)

 - [IdPhotosList](docs/IdPhotosList.md)

 - [IdentityEnhancedBreakdown](docs/IdentityEnhancedBreakdown.md)

 - [IdentityEnhancedBreakdownAddress](docs/IdentityEnhancedBreakdownAddress.md)

 - [IdentityEnhancedBreakdownAddressBreakdown](docs/IdentityEnhancedBreakdownAddressBreakdown.md)

 - [IdentityEnhancedBreakdownAddressBreakdownCreditAgencies](docs/IdentityEnhancedBreakdownAddressBreakdownCreditAgencies.md)

 - [IdentityEnhancedBreakdownAddressBreakdownCreditAgenciesProperties](docs/IdentityEnhancedBreakdownAddressBreakdownCreditAgenciesProperties.md)

 - [IdentityEnhancedBreakdownAddressBreakdownTelephoneDatabase](docs/IdentityEnhancedBreakdownAddressBreakdownTelephoneDatabase.md)

 - [IdentityEnhancedBreakdownAddressBreakdownVotingRegister](docs/IdentityEnhancedBreakdownAddressBreakdownVotingRegister.md)

 - [IdentityEnhancedBreakdownDateOfBirth](docs/IdentityEnhancedBreakdownDateOfBirth.md)

 - [IdentityEnhancedBreakdownDateOfBirthBreakdown](docs/IdentityEnhancedBreakdownDateOfBirthBreakdown.md)

 - [IdentityEnhancedBreakdownDateOfBirthBreakdownCreditAgencies](docs/IdentityEnhancedBreakdownDateOfBirthBreakdownCreditAgencies.md)

 - [IdentityEnhancedBreakdownDateOfBirthBreakdownVotingRegister](docs/IdentityEnhancedBreakdownDateOfBirthBreakdownVotingRegister.md)

 - [IdentityEnhancedBreakdownMortality](docs/IdentityEnhancedBreakdownMortality.md)

 - [IdentityEnhancedBreakdownSources](docs/IdentityEnhancedBreakdownSources.md)

 - [IdentityEnhancedBreakdownSourcesBreakdown](docs/IdentityEnhancedBreakdownSourcesBreakdown.md)

 - [IdentityEnhancedBreakdownSourcesBreakdownTotalSources](docs/IdentityEnhancedBreakdownSourcesBreakdownTotalSources.md)

 - [IdentityEnhancedBreakdownSourcesBreakdownTotalSourcesProperties](docs/IdentityEnhancedBreakdownSourcesBreakdownTotalSourcesProperties.md)

 - [IdentityEnhancedProperties](docs/IdentityEnhancedProperties.md)

 - [IdentityEnhancedPropertiesMatchedAddressesInner](docs/IdentityEnhancedPropertiesMatchedAddressesInner.md)

 - [IdentityEnhancedReport](docs/IdentityEnhancedReport.md)

 - [IndiaPanReport](docs/IndiaPanReport.md)

 - [IndiaPanReportAllOfBreakdown](docs/IndiaPanReportAllOfBreakdown.md)

 - [IndiaPanReportAllOfBreakdownDevice](docs/IndiaPanReportAllOfBreakdownDevice.md)

 - [IndiaPanReportAllOfBreakdownDeviceBreakdown](docs/IndiaPanReportAllOfBreakdownDeviceBreakdown.md)

 - [IndiaPanReportAllOfBreakdownDeviceBreakdownPanValid](docs/IndiaPanReportAllOfBreakdownDeviceBreakdownPanValid.md)

 - [IndiaPanReportAllOfProperties](docs/IndiaPanReportAllOfProperties.md)

 - [IndiaPanReportAllOfPropertiesDevice](docs/IndiaPanReportAllOfPropertiesDevice.md)

 - [KnownFacesBreakdown](docs/KnownFacesBreakdown.md)

 - [KnownFacesBreakdownImageIntegrity](docs/KnownFacesBreakdownImageIntegrity.md)

 - [KnownFacesBreakdownPreviouslySeenFaces](docs/KnownFacesBreakdownPreviouslySeenFaces.md)

 - [KnownFacesProperties](docs/KnownFacesProperties.md)

 - [KnownFacesPropertiesMatchesInner](docs/KnownFacesPropertiesMatchesInner.md)

 - [KnownFacesReport](docs/KnownFacesReport.md)

 - [LivePhoto](docs/LivePhoto.md)

 - [LivePhotoResponse](docs/LivePhotoResponse.md)

 - [LivePhotosList](docs/LivePhotosList.md)

 - [LiveVideo](docs/LiveVideo.md)

 - [LiveVideosList](docs/LiveVideosList.md)

 - [Location](docs/Location.md)

 - [LocationBuilder](docs/LocationBuilder.md)

 - [LocationShared](docs/LocationShared.md)

 - [MotionCapture](docs/MotionCapture.md)

 - [MotionCapturesList](docs/MotionCapturesList.md)

 - [PhotoAutoReasons](docs/PhotoAutoReasons.md)

 - [PhotoReasons](docs/PhotoReasons.md)

 - [ProofOfAddressBreakdown](docs/ProofOfAddressBreakdown.md)

 - [ProofOfAddressBreakdownDataComparison](docs/ProofOfAddressBreakdownDataComparison.md)

 - [ProofOfAddressBreakdownDataComparisonBreakdown](docs/ProofOfAddressBreakdownDataComparisonBreakdown.md)

 - [ProofOfAddressBreakdownDocumentClassification](docs/ProofOfAddressBreakdownDocumentClassification.md)

 - [ProofOfAddressBreakdownDocumentClassificationBreakdown](docs/ProofOfAddressBreakdownDocumentClassificationBreakdown.md)

 - [ProofOfAddressBreakdownImageIntegrity](docs/ProofOfAddressBreakdownImageIntegrity.md)

 - [ProofOfAddressBreakdownImageIntegrityBreakdown](docs/ProofOfAddressBreakdownImageIntegrityBreakdown.md)

 - [ProofOfAddressProperties](docs/ProofOfAddressProperties.md)

 - [ProofOfAddressReport](docs/ProofOfAddressReport.md)

 - [RepeatAttemptsList](docs/RepeatAttemptsList.md)

 - [RepeatAttemptsListRepeatAttemptsInner](docs/RepeatAttemptsListRepeatAttemptsInner.md)

 - [Report](docs/Report.md)

 - [ReportDocument](docs/ReportDocument.md)

 - [ReportName](docs/ReportName.md)

 - [ReportResult](docs/ReportResult.md)

 - [ReportShared](docs/ReportShared.md)

 - [ReportStatus](docs/ReportStatus.md)

 - [ReportSubResult](docs/ReportSubResult.md)

 - [ReportsList](docs/ReportsList.md)

 - [ResultsFeedback](docs/ResultsFeedback.md)

 - [SdkToken](docs/SdkToken.md)

 - [SdkTokenBuilder](docs/SdkTokenBuilder.md)

 - [SdkTokenRequest](docs/SdkTokenRequest.md)

 - [SdkTokenResponse](docs/SdkTokenResponse.md)

 - [Task](docs/Task.md)

 - [TaskItem](docs/TaskItem.md)

 - [TimelineFileReference](docs/TimelineFileReference.md)

 - [UsDrivingLicenceBreakdown](docs/UsDrivingLicenceBreakdown.md)

 - [UsDrivingLicenceBreakdownAddress](docs/UsDrivingLicenceBreakdownAddress.md)

 - [UsDrivingLicenceBreakdownAddressBreakdown](docs/UsDrivingLicenceBreakdownAddressBreakdown.md)

 - [UsDrivingLicenceBreakdownDocument](docs/UsDrivingLicenceBreakdownDocument.md)

 - [UsDrivingLicenceBreakdownDocumentBreakdown](docs/UsDrivingLicenceBreakdownDocumentBreakdown.md)

 - [UsDrivingLicenceBreakdownPersonal](docs/UsDrivingLicenceBreakdownPersonal.md)

 - [UsDrivingLicenceBreakdownPersonalBreakdown](docs/UsDrivingLicenceBreakdownPersonalBreakdown.md)

 - [UsDrivingLicenceBuilder](docs/UsDrivingLicenceBuilder.md)

 - [UsDrivingLicenceReport](docs/UsDrivingLicenceReport.md)

 - [UsDrivingLicenceShared](docs/UsDrivingLicenceShared.md)

 - [VideoReasons](docs/VideoReasons.md)

 - [WatchlistAmlBreakdown](docs/WatchlistAmlBreakdown.md)

 - [WatchlistAmlBreakdownAdverseMedia](docs/WatchlistAmlBreakdownAdverseMedia.md)

 - [WatchlistAmlBreakdownLegalAndRegulatoryWarnings](docs/WatchlistAmlBreakdownLegalAndRegulatoryWarnings.md)

 - [WatchlistAmlBreakdownPoliticallyExposedPerson](docs/WatchlistAmlBreakdownPoliticallyExposedPerson.md)

 - [WatchlistAmlBreakdownSanction](docs/WatchlistAmlBreakdownSanction.md)

 - [WatchlistAmlProperties](docs/WatchlistAmlProperties.md)

 - [WatchlistAmlReport](docs/WatchlistAmlReport.md)

 - [WatchlistEnhancedBreakdown](docs/WatchlistEnhancedBreakdown.md)

 - [WatchlistEnhancedProperties](docs/WatchlistEnhancedProperties.md)

 - [WatchlistEnhancedReport](docs/WatchlistEnhancedReport.md)

 - [WatchlistMonitor](docs/WatchlistMonitor.md)

 - [WatchlistMonitorBuilder](docs/WatchlistMonitorBuilder.md)

 - [WatchlistMonitorMatch](docs/WatchlistMonitorMatch.md)

 - [WatchlistMonitorMatchesList](docs/WatchlistMonitorMatchesList.md)

 - [WatchlistMonitorMatchesUpdater](docs/WatchlistMonitorMatchesUpdater.md)

 - [WatchlistMonitorResponse](docs/WatchlistMonitorResponse.md)

 - [WatchlistMonitorShared](docs/WatchlistMonitorShared.md)

 - [WatchlistMonitorsList](docs/WatchlistMonitorsList.md)

 - [WatchlistPepsOnlyReport](docs/WatchlistPepsOnlyReport.md)

 - [WatchlistSanctionsOnlyReport](docs/WatchlistSanctionsOnlyReport.md)

 - [WatchlistStandardBreakdown](docs/WatchlistStandardBreakdown.md)

 - [WatchlistStandardProperties](docs/WatchlistStandardProperties.md)

 - [WatchlistStandardReport](docs/WatchlistStandardReport.md)

 - [Webhook](docs/Webhook.md)

 - [WebhookBuilder](docs/WebhookBuilder.md)

 - [WebhookCreate](docs/WebhookCreate.md)

 - [WebhookEvent](docs/WebhookEvent.md)

 - [WebhookEventPayload](docs/WebhookEventPayload.md)

 - [WebhookEventPayloadObject](docs/WebhookEventPayloadObject.md)

 - [WebhookEventType](docs/WebhookEventType.md)

 - [WebhookResend](docs/WebhookResend.md)

 - [WebhookResponse](docs/WebhookResponse.md)

 - [WebhookShared](docs/WebhookShared.md)

 - [WebhookUpdate](docs/WebhookUpdate.md)

 - [WebhookUpdater](docs/WebhookUpdater.md)

 - [WebhooksList](docs/WebhooksList.md)

 - [WebhooksResendItem](docs/WebhooksResendItem.md)

 - [WorkflowRun](docs/WorkflowRun.md)

 - [WorkflowRunBuilder](docs/WorkflowRunBuilder.md)

 - [WorkflowRunRequest](docs/WorkflowRunRequest.md)

 - [WorkflowRunResponse](docs/WorkflowRunResponse.md)

 - [WorkflowRunResponseError](docs/WorkflowRunResponseError.md)

 - [WorkflowRunShared](docs/WorkflowRunShared.md)

 - [WorkflowRunSharedLink](docs/WorkflowRunSharedLink.md)

## Documentation For Authorization

Authentication schemes defined for the API:

### Token

- **Type**: API key

- **API key parameter name**: Authorization

- **Location**: HTTP header

Note, each API key must be added to a map of `map[string]APIKey` where the key is: Token and passed in as the auth context for each request.

Example

```go

auth := context.WithValue(

		context.Background(),

		openapi.ContextAPIKeys,

		map[string]openapi.APIKey{

			"Token": {Key: "API_KEY_STRING"},

		},

	)

r, err := client.Service.Operation(auth, args)

```

## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains

a number of utility functions to easily obtain pointers to values of basic types.

Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`

* `PtrInt`

* `PtrInt32`

* `PtrInt64`

* `PtrFloat`

* `PtrFloat32`

* `PtrFloat64`

* `PtrString`

* `PtrTime`

## Author