Skip to main content
POST
/
api
/
v1
/
exchange
/
verify
Verify account identity.
curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/exchange/verify \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "authToken": "<string>",
  "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountInfo": [
    "firstName"
  ]
}
'
{
  "status": "ok",
  "message": "<string>",
  "displayMessage": "<string>",
  "errorHash": "<string>",
  "errorType": "<string>",
  "errorData": "<unknown>",
  "content": {
    "integrationName": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "accountNumber": "<string>",
    "email": "<string>",
    "mobileNumber": "<string>",
    "companyName": "<string>",
    "countryCode": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "address": "<string>",
    "idType": "none",
    "idNumber": "<string>",
    "dateOfBirth": 123
  }
}

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<uuid>

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

Successfully returns account details.

​
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

​
errorHash
string | null

An error grouping hash from string components and caller information. Used by bugsnag on FE for correct error grouping

​
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
unknown
​
content
object