GET
/
v1
/
search
/
recipient
curl --request GET \
  --url https://client-api.dev.finhost.io/v1/search/recipient \
  --header 'Authorization: Bearer <token>'
{
  "name": "Mykola N.",
  "accountId": "uuid",
  "type": "individual"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
currency
string
required

Currency code (ISO 4217)

Required string length: 3
​
attribute
enum<string>
required

Attribute to use for search

Available options:
phone,
email
​
value
string
required

Value of the search attribute

​
companyId
string

Company id

Response

200 - application/json
200 response

The response is of type object.