Contact Models

Contact

{
    "name": "string",
    "first_name": "string",
    "last_name": "string",
    "email_address": "string",
    "work_contact_number": "string",
    "home_contact_number": "string",
    "mobile_contact_number": "string",
    "address_line_1": "string",
    "address_line_2": "string",
    "city": "string",
    "country_code": "string",
    "country_name": "string",
    "post_code": "string",
    "password_reset_required": "boolean",
    "language": "string",
    "locale": "string",
    "time_zone": "string",
    "has_online_access": "boolean",
    "can_authorise_payments": "boolean",
    "can_make_same_currency_payments": "boolean",
    "can_make_independent_payments": "boolean",
    "can_manage_beneficiaries": "boolean",
    "can_manage_beneficiaries_groups": "boolean",
    "can_manage_contacts": "boolean",
    "can_manage_fix_forwards": "boolean",
    "can_manage_multipayments": "boolean",
    "can_manage_payments": "boolean",
    "can_manage_permissions": "boolean",
    "can_trade": "boolean",
    "contact_id": "string"
}

This model is a representation of a contact. Fields

string

Full name of the contact

string

First name of the contact

string

Last name of the contact

string

Always present. Email address/username of the contact

string

The work contact number of the contact

string

The home contact number of the contact

string

The mobile contact number of the contact

string

The first address line of the contact

string

The second address line of the contact

string

The city name of the contact

string

Country as ISO 3166 two-character code

string

Full name of the country

string

The postcode of the contact

boolean

true if contact needs to reset their password, false otherwise

string

Language expressed as ISO 639-1 two-character code

string

Locale expressed as ISO 639-1 two-character code

string

The time zone of the contact

boolean

Contact has access to Ebury Online

boolean

Contact can authorise payments

boolean

Contact can create trades and assign same currency payments

boolean

Contact can make independent payments

boolean

Contact can manage beneficiaries

boolean

Contact can manage beneficiaries groups

boolean

Contact can manage contacts

boolean

Contact can manage fixed forwards

boolean

Contact can manage multipayments

boolean

Contact can manage payments

boolean

Contact can manage permissions

boolean

Contact can execute spot trades

string

Unique identifier for the Contact

ContactUpdate

{
    "language": "string",
    "locale": "string",
    "time_zone": "string",
    "has_online_access": "boolean",
    "can_authorise_payments": "boolean",
    "can_make_same_currency_payments": "boolean",
    "can_manage_beneficiaries": "boolean",
    "can_manage_beneficiaries_groups": "boolean",
    "can_manage_contacts": "boolean",
    "can_manage_fix_forwards": "boolean",
    "can_manage_multipayments": "boolean",
    "can_manage_payments": "boolean",
    "can_manage_permissions": "boolean",
    "can_trade": "boolean"
}

This model is a representation of the updateable data of a contact. Fields

string

Language expressed as ISO 639-1 two-character code

string

Locale expressed as ISO 639-1 two-character code

string

The time zone of the contact

boolean

Contact has access to Ebury Online

boolean

Contact can authorise payments

boolean

Contact can create trades and assign same currency payments

boolean

Contact can manage beneficiaries

boolean

Contact can manage beneficiaries groups

boolean

Contact can manage contacts

boolean

Contact can manage fixed forwards

boolean

Contact can manage multipayments

boolean

Contact can manage payments

boolean

Contact can manage permissions

boolean

Contact can execute trades

​Contact

​ContactUpdate

Contact

ContactUpdate