Interface IIdVerificationClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as get report, get image and create embedded verification url.

public interface IIdVerificationClient : IApiAccessor

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Methods

CreateEmbeddedVerificationUrl(string, EmbeddedVerificationRequest)

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

EmbeddedVerificationCreated CreateEmbeddedVerificationUrl(string documentId, EmbeddedVerificationRequest embeddedVerificationRequest = null)

Parameters

documentId string

Gets or sets Document Id.

embeddedVerificationRequest EmbeddedVerificationRequest

Gets or sets embedded verification request.

Returns

EmbeddedVerificationCreated

Embedded Verification Url.

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedVerificationUrlAsync(string, EmbeddedVerificationRequest)

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

Task<EmbeddedVerificationCreated> CreateEmbeddedVerificationUrlAsync(string documentId, EmbeddedVerificationRequest embeddedVerificationRequest = null)

Parameters

documentId string

Gets or sets Document Id.

embeddedVerificationRequest EmbeddedVerificationRequest

Gets or sets embedded verification request.

Returns

Task<EmbeddedVerificationCreated>

A Task of Embedded Verification Url.

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedVerificationUrlWithHttpInfo(string, EmbeddedVerificationRequest)

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

ApiResponse<EmbeddedVerificationCreated> CreateEmbeddedVerificationUrlWithHttpInfo(string documentId, EmbeddedVerificationRequest embeddedVerificationRequest = null)

Parameters

documentId string

Gets or sets Document Id.

embeddedVerificationRequest EmbeddedVerificationRequest

Gets or sets embedded verification request.

Returns

ApiResponse<EmbeddedVerificationCreated>

A ApiResponse of Embedded Verification Url.

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedVerificationUrlWithHttpInfoAsync(string, EmbeddedVerificationRequest)

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

Task<ApiResponse<EmbeddedVerificationCreated>> CreateEmbeddedVerificationUrlWithHttpInfoAsync(string documentId, EmbeddedVerificationRequest embeddedVerificationRequest = null)

Parameters

documentId string

Gets or sets Document Id.

embeddedVerificationRequest EmbeddedVerificationRequest

Gets or sets embedded verification request.

Returns

Task<ApiResponse<EmbeddedVerificationCreated>>

Task of ApiResponse of Embedded Verification Url.

Exceptions

ApiException

Thrown when fails to make API call.

GetImage(string, VerificationImageRequest)

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

Stream GetImage(string documentId, VerificationImageRequest verificationImageRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationImageRequest VerificationImageRequest

Gets or sets verification image request.

Returns

Stream

A Id Verification Images in File Stream.

Exceptions

ApiException

Thrown when fails to make API call.

GetImageAsync(string, VerificationImageRequest)

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

Task<Stream> GetImageAsync(string documentId, VerificationImageRequest verificationImageRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationImageRequest VerificationImageRequest

Gets or sets verification image request.

Returns

Task<Stream>

A Task of Id Verification Images in File Stream.

Exceptions

ApiException

Thrown when fails to make API call.

GetImageWithHttpInfo(string, VerificationImageRequest)

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

ApiResponse<Stream> GetImageWithHttpInfo(string documentId, VerificationImageRequest verificationImageRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationImageRequest VerificationImageRequest

Gets or sets verification image request.

Returns

ApiResponse<Stream>

A ApiResponse of Id Verification Images in File Stream.

Exceptions

ApiException

Thrown when fails to make API call.

GetImageWithHttpInfoAsync(string, VerificationImageRequest)

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

Task<ApiResponse<Stream>> GetImageWithHttpInfoAsync(string documentId, VerificationImageRequest verificationImageRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationImageRequest VerificationImageRequest

Gets or sets verification image request.

Returns

Task<ApiResponse<Stream>>

A Task of ApiResponse of Id Verification Images in File Stream.

Exceptions

ApiException

Thrown when fails to make API call.

GetReport(string, VerificationReportRequest)

Retrieve the ID verification report for the specified document signer.

IdReport GetReport(string documentId, VerificationReportRequest verificationReportRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationReportRequest VerificationReportRequest

Gets or sets verification report request.

Returns

IdReport

A Id Verification Report.

Exceptions

ApiException

Thrown when fails to make API call.

GetReportAsync(string, VerificationReportRequest)

Retrieve the ID verification report for the specified document signer.

Task<IdReport> GetReportAsync(string documentId, VerificationReportRequest verificationReportRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationReportRequest VerificationReportRequest

Gets or sets verification report request.

Returns

Task<IdReport>

A Task of Id Verification Report.

Exceptions

ApiException

Thrown when fails to make API call.

GetReportWithHttpInfo(string, VerificationReportRequest)

Retrieve the ID verification report for the specified document signer.

ApiResponse<IdReport> GetReportWithHttpInfo(string documentId, VerificationReportRequest verificationReportRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationReportRequest VerificationReportRequest

Gets or sets verification report request.

Returns

ApiResponse<IdReport>

A ApiResponse of Id Verification Report.

Exceptions

ApiException

Thrown when fails to make API call.

GetReportWithHttpInfoAsync(string, VerificationReportRequest)

Retrieve the ID verification report for the specified document signer.

Task<ApiResponse<IdReport>> GetReportWithHttpInfoAsync(string documentId, VerificationReportRequest verificationReportRequest = null)

Parameters

documentId string

Gets or sets Document Id.

verificationReportRequest VerificationReportRequest

Gets or sets verification report request.

Returns

Task<ApiResponse<IdReport>>

A Task of ApiResponse of Id Verification Report.

Exceptions

ApiException

Thrown when fails to make API call.