Class IdentityVerificationApi

java.lang.Object

com.boldsign.api.IdentityVerificationApi

public class IdentityVerificationApi
extends Object

Constructor Summary

Constructors

Constructor	Description
IdentityVerificationApi()
IdentityVerificationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
EmbeddedFileLink	createEmbeddedVerificationUrl(String documentId, EmbeddedFileDetails embeddedFileDetails)	Generate a URL that embeds manual ID verification for the specified document signer into your application.
okhttp3.Call	createEmbeddedVerificationUrlAsync(String documentId, EmbeddedFileDetails embeddedFileDetails, ApiCallback<EmbeddedFileLink> _callback)	Generate a URL that embeds manual ID verification for the specified document signer into your application.
okhttp3.Call	createEmbeddedVerificationUrlCall(String documentId, EmbeddedFileDetails embeddedFileDetails, ApiCallback _callback)	Build call for createEmbeddedVerificationUrl
ApiResponse<EmbeddedFileLink>	createEmbeddedVerificationUrlWithHttpInfo(String documentId, EmbeddedFileDetails embeddedFileDetails)	Generate a URL that embeds manual ID verification for the specified document signer into your application.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
File	image(String documentId, DownloadImageRequest downloadImageRequest)	Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.
okhttp3.Call	imageAsync(String documentId, DownloadImageRequest downloadImageRequest, ApiCallback<File> _callback)	Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.
okhttp3.Call	imageCall(String documentId, DownloadImageRequest downloadImageRequest, ApiCallback _callback)	Build call for image
ApiResponse<File>	imageWithHttpInfo(String documentId, DownloadImageRequest downloadImageRequest)	Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.
IdReport	report(String documentId, VerificationDataRequest verificationDataRequest)	Retrieve the ID verification report for the specified document signer.
okhttp3.Call	reportAsync(String documentId, VerificationDataRequest verificationDataRequest, ApiCallback<IdReport> _callback)	Retrieve the ID verification report for the specified document signer.
okhttp3.Call	reportCall(String documentId, VerificationDataRequest verificationDataRequest, ApiCallback _callback)	Build call for report
ApiResponse<IdReport>	reportWithHttpInfo(String documentId, VerificationDataRequest verificationDataRequest)	Retrieve the ID verification report for the specified document signer.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IdentityVerificationApi

public IdentityVerificationApi()

IdentityVerificationApi

public IdentityVerificationApi(ApiClient apiClient)

Method Details

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)

createEmbeddedVerificationUrlCall

public okhttp3.Call createEmbeddedVerificationUrlCall(String documentId,
 EmbeddedFileDetails embeddedFileDetails,
 ApiCallback _callback)
                                               throws ApiException

Build call for createEmbeddedVerificationUrl

Parameters:

documentId - The document id. (required)

embeddedFileDetails - The embedded verification link request. (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
200	OK	-
401	Unauthorized	-
403	Forbidden	-

createEmbeddedVerificationUrl

public EmbeddedFileLink createEmbeddedVerificationUrl(String documentId,
 EmbeddedFileDetails embeddedFileDetails)
                                               throws ApiException

Generate a URL that embeds manual ID verification for the specified document signer into your application.

Parameters:

documentId - The document id. (required)

embeddedFileDetails - The embedded verification link request. (optional)

Returns:

EmbeddedFileLink

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	OK	-
401	Unauthorized	-
403	Forbidden	-

createEmbeddedVerificationUrlWithHttpInfo

public ApiResponse<EmbeddedFileLink> createEmbeddedVerificationUrlWithHttpInfo(String documentId,
 EmbeddedFileDetails embeddedFileDetails)
                                                                        throws ApiException

Generate a URL that embeds manual ID verification for the specified document signer into your application.

Parameters:

documentId - The document id. (required)

embeddedFileDetails - The embedded verification link request. (optional)

Returns:

ApiResponse<EmbeddedFileLink>

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	OK	-
401	Unauthorized	-
403	Forbidden	-

createEmbeddedVerificationUrlAsync

public okhttp3.Call createEmbeddedVerificationUrlAsync(String documentId,
 EmbeddedFileDetails embeddedFileDetails,
 ApiCallback<EmbeddedFileLink> _callback)
                                                throws ApiException

Generate a URL that embeds manual ID verification for the specified document signer into your application. (asynchronously)

Parameters:

documentId - The document id. (required)

embeddedFileDetails - The embedded verification link request. (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
200	OK	-
401	Unauthorized	-
403	Forbidden	-

imageCall

public okhttp3.Call imageCall(String documentId,
 DownloadImageRequest downloadImageRequest,
 ApiCallback _callback)
                       throws ApiException

Build call for image

Parameters:

documentId - The document id. (required)

downloadImageRequest - The download image request. (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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

image

public File image(String documentId,
 DownloadImageRequest downloadImageRequest)
           throws ApiException

Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.

Parameters:

documentId - The document id. (required)

downloadImageRequest - The download image request. (required)

Returns:

File

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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

imageWithHttpInfo

public ApiResponse<File> imageWithHttpInfo(String documentId,
 DownloadImageRequest downloadImageRequest)
                                    throws ApiException

Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.

Parameters:

documentId - The document id. (required)

downloadImageRequest - The download image request. (required)

Returns:

ApiResponse<File>

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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

imageAsync

public okhttp3.Call imageAsync(String documentId,
 DownloadImageRequest downloadImageRequest,
 ApiCallback<File> _callback)
                        throws ApiException

Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID. (asynchronously)

Parameters:

documentId - The document id. (required)

downloadImageRequest - The download image request. (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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

reportCall

public okhttp3.Call reportCall(String documentId,
 VerificationDataRequest verificationDataRequest,
 ApiCallback _callback)
                        throws ApiException

Build call for report

Parameters:

documentId - The document id. (required)

verificationDataRequest - The download image request. (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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

report

public IdReport report(String documentId,
 VerificationDataRequest verificationDataRequest)
                throws ApiException

Retrieve the ID verification report for the specified document signer.

Parameters:

documentId - The document id. (required)

verificationDataRequest - The download image request. (required)

Returns:

IdReport

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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

reportWithHttpInfo

public ApiResponse<IdReport> reportWithHttpInfo(String documentId,
 VerificationDataRequest verificationDataRequest)
                                         throws ApiException

Retrieve the ID verification report for the specified document signer.

Parameters:

documentId - The document id. (required)

verificationDataRequest - The download image request. (required)

Returns:

ApiResponse<IdReport>

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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

reportAsync

public okhttp3.Call reportAsync(String documentId,
 VerificationDataRequest verificationDataRequest,
 ApiCallback<IdReport> _callback)
                         throws ApiException

Retrieve the ID verification report for the specified document signer. (asynchronously)

Parameters:

documentId - The document id. (required)

verificationDataRequest - The download image request. (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	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-