POST
/
api
/
v1
/
exchange
/
verify

Authorizations

X-Client-Secret
string
header
required

Contact Mesh to get client Secret

X-Client-Id
string
header
required

Contact Mesh to get client Id

Body

application/json

Exchange account info request.

authToken
string | null

Auth token that allows connecting to the target institution.

integrationId
string

The Id which uniquely identifies the integration.

accountInfo
enum<string>[] | null

Account information to return.

Available options:
firstName,
middleName,
lastName,
accountNumber,
email,
mobileNumber,
companyName,
countryCode,
city,
postalCode,
address,
id,
dateOfBirth

Response

200 - application/json
status
enum<string>
Available options:
ok,
serverFailure,
permissionDenied,
badRequest,
notFound,
conflict,
tooManyRequest,
locked,
unavailableForLegalReasons
message
string | null

A message generated by the API

displayMessage
string | null

User-friendly display message that can be presented to the end user

errorType
string | null

Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.

errorData
any | null
content
object