POST
/
api
/
v1
/
exchange
/
verify
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": "Secret authentication token",
  "integrationId": "4d3364d9-fa09-4382-ad4e-5cab2e355fd4",
  "accountInfo": [
    "companyName",
    "firstName",
    "lastName"
  ]
}'
{
  "content": {
    "integrationName": "Coinbase",
    "firstName": "Firstname",
    "middleName": "Midlename",
    "lastName": "Lastname",
    "accountNumber": "1234567",
    "email": "enduser@domain.com",
    "mobileNumber": "123456798",
    "companyName": "MyCorp Inc.",
    "countryCode": "GB",
    "city": "City Name",
    "postalCode": "4251",
    "idType": "idCard",
    "idNumber": "123",
    "dateOfBirth": 574732800
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

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

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