Class IdVerificationClient

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 class IdVerificationClient : IIdVerificationClient, IApiAccessor

Inheritance

object

IdVerificationClient

Implements

IIdVerificationClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

IdVerificationClient()

Initializes a new instance of the IdVerificationClient class.

public IdVerificationClient()

IdVerificationClient(ApiClient)

Initializes a new instance of the IdVerificationClient class using Configuration object.

public IdVerificationClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient.

IdVerificationClient(Configuration)

Initializes a new instance of the IdVerificationClient class using Configuration object.

public IdVerificationClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration.

IdVerificationClient(string)

Initializes a new instance of the IdVerificationClient class.

public IdVerificationClient(string basePath)

Parameters

basePath string

Gets or set the basePath.

Properties

Configuration

Gets or sets the configuration object.

public Configuration Configuration { get; set; }

Property Value

Configuration

An instance of the Configuration.

ExceptionFactory

Gets or sets provides a factory method hook for the creation of exceptions.

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

ExceptionFactory

Methods

CreateEmbeddedVerificationUrl(string, EmbeddedVerificationRequest)

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

public 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.

public 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.

public 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.

public 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.

GetBasePath()

Id Verification paths.

public string GetBasePath()

Returns

string

The base path.

GetImage(string, VerificationImageRequest)

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

public 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.

public 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.

public 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.

public 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.

public 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.

public 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.

public 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.

public 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.