Contacts

Get a contact

Get a contact by contact's identifier.

get/contacts/{contact_id}

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/contacts/{contact_id}
  • Auth: API key in header x-api-key

Response

The data of a contact.

address_line_1string

The first address line of a contact.

address_line_2string

The second address line of a contact.

citystring

The city name of a contact.

country_codestring

The ISO 3166-1 alpha-2 code of the contact's country.

country_namestring

The name of the contact's country.

email_addressstring email required

The email address of a contact.

first_namestring

The first name of the contact.

home_contact_numberstring

The home contact number of a contact.

last_namestring

The last name of the contact.

mobile_contact_numberstring

The mobile contact number of a contact.

namestring

The full name of a contact.

password_reset_requiredboolean

True if contact needs to reset his password, False otherwise.

post_codestring

The post code of the contact.

work_contact_numberstring

The work contact number of a contact.

can_authorise_paymentsboolean

True if contact can authorise payments, False otherwise.

can_make_same_currency_paymentsboolean

True if contact can create trades and assign same currency payments, False otherwise.

can_manage_beneficiariesboolean

True if contact can manage beneficiaries, False otherwise.

can_manage_beneficiaries_groupsboolean

True if can manage beneficiaries groups, False otherwise.

can_manage_contactsboolean

True if contact can manage contacts, False otherwise.

can_manage_fix_forwardsboolean

True if contact can manage fixed forwards, False otherwise.

can_manage_multipaymentsboolean

True if contact can manage multipayments, False otherwise.

can_manage_paymentsboolean

True if contact can manage payments, False otherwise.

can_manage_permissionsboolean

True if contact can manage permissions, False otherwise.

can_tradeboolean

True if contact can execute trades, False otherwise.

can_make_independent_paymentsboolean

True if contact can make independent payments, False otherwise.

can_drawdownboolean

True if contact can create drawdowns, False otherwise.

can_get_paidboolean

True if contact can see/create get paid requests, False otherwise.

can_manage_third_partiesboolean

True if contact can manage third parties, False otherwise.

can_authorize_payment_lvl_1boolean

True if contact can authorise payments at level 1, False otherwise.

can_authorize_payment_lvl_2boolean

True if contact can authorise payments at level 2, False otherwise.

can_authorize_payment_lvl_3boolean

True if contact can authorise payments at level 3, False otherwise.

can_authorize_payment_lvl_4boolean

True if contact can authorise payments at level 4, False otherwise.

can_trade_financeboolean

True if contact can access trade finance, False otherwise.

can_select_multipayment_delivery_dateboolean

True if contact can select delivery date in multipayments, False otherwise.

can_manage_trade_finance_permissionsboolean

True if contact can manage trade finance permissions, False otherwise.

can_create_card_topupboolean

True if contact can create card topup transactions, False otherwise.

can_create_card_offloadboolean

True if contact can create card offload transactions, False otherwise.

has_online_accessboolean

True if contact has access to Ebury Online, False otherwise.

languagestring

The ISO 639-1:2002 code of the contact's language.

localestring

The ISO 639-1:2002 code of the contact's locale.

time_zonestring

The time zone of the contact.

contact_idstring required

The identifier of the contact.

Changes

No recorded changes to this operation across all 1 revision of this API.