Skip to main content
POST
Get profile data

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

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

teamCode
string | null
read-only

Opaque team code for error routing. Resolved from exception origin or caller file path via CODEOWNERS. Format: 2-character code (e.g., "7K", "M2"). Use for alerting/routing, not display.

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