index.VerificationsApi.md

@standard-crypto/farcaster-js / Modules / index / VerificationsApi

Class: VerificationsApi

index.VerificationsApi

VerificationsApi - object-oriented interface

Export

Hierarchy

• BaseAPI

  ↳ VerificationsApi

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• configuration

Methods

• v2VerificationsGet

Constructors

constructor

• new VerificationsApi(configuration?, basePath?, axios?)

Parameters

Name	Type	Default value
configuration?	Configuration	undefined
basePath	string	BASE_PATH
axios	AxiosInstance	globalAxios

Inherited from

BaseAPI.constructor

Defined in

src/merkleAPI/swagger/base.ts:50

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Defined in

src/merkleAPI/swagger/base.ts:53

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Defined in

src/merkleAPI/swagger/base.ts:52

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Defined in

src/merkleAPI/swagger/base.ts:48

Methods

v2VerificationsGet

▸ v2VerificationsGet(fid, limit, authorization, cursor?, options?): Promise<AxiosResponse<InlineResponse20016, any>>

Get all verifications for the authenticated user.

Throws

Memberof

VerificationsApi

Parameters

Name	Type	Description
fid	number	-
limit	number
authorization	string
cursor?	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse20016, any>>

Defined in

src/merkleAPI/swagger/apis/verifications-api.ts:221