Class VerificationStatusApi

Hierarchy

VerificationDomainApi
- VerificationStatusApi

Index

Methods

getById getByIdentity getByReference setBasePath

Methods

getById

getById(
data: VerificationStatusByIdRequestData,
): Promise<VerificationReportResponse>
Get verification by ID Queries the verification result by sending the verification ID. With this query you can get the result of a verification.
Parameters
- data: VerificationStatusByIdRequestData
  The data to provide to the API call.
Returns Promise<VerificationReportResponse>

getByIdentity

getByIdentity(
data: VerificationStatusByIdentityRequestData,
): Promise<VerificationReportResponse>
Get verification by Identity Queries the verification result by sending the verification Identity (usually a phone number) and its method. With this query you can get the result of a verification.
Parameters
- data: VerificationStatusByIdentityRequestData
  The data to provide to the API call.
Returns Promise<VerificationReportResponse>

getByReference

getByReference(
data: VerificationStatusByReferenceRequestData,
): Promise<VerificationReportResponse>
Get verification by Reference Queries the verification result by sending the verification Reference. With this query you can get the result of a verification.
Parameters
- data: VerificationStatusByReferenceRequestData
  The data to provide to the API call.
Returns Promise<VerificationReportResponse>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from VerificationDomainApi.setBasePath