Search recipient by alias - Finhost

Receive internal recipient account

curl --request GET \
  --url https://client-api.dev.finhost.io/v2/recipients/search/aliases/{alias} \
  --header 'Authorization: Bearer <token>'

{
  "name": "Mykola N.",
  "accountId": "uuid",
  "type": "individual"
}

GET

recipients

aliases

{alias}

Receive internal recipient account

curl --request GET \
  --url https://client-api.dev.finhost.io/v2/recipients/search/aliases/{alias} \
  --header 'Authorization: Bearer <token>'

{
  "name": "Mykola N.",
  "accountId": "uuid",
  "type": "individual"
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

alias

string

required

companyId

string

Company id

200 - application/json

200 response

name

string

required

EndUser name

Example:

"Mykola N."

accountId

string

required

Account ID

Example:

"uuid"

type

string

required

EndUser type(individual or company)

Example:

"individual"