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
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Ebury","colors":{"primary":"#73B0CA","light":"#73B0CA","dark":"#73B0CA"},"logo":{"light":"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/light.svg?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=171beecd1c422bb5a896ebdf7a2bf872","dark":"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/dark.svg?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=30c0d6ec67e487abc63236d0cdfb784e"},"favicon":"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/favicon.png?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=64cdb26e56d359bc7493b9fb4bd17158","navbar":{"links":[{"href":"https://postman.ebury.io/","label":"Postman"}],"primary":{"type":"button","label":"Get started","href":"https://ebury.com/contact-us"}},"footer":{"socials":{"facebook":"https://www.facebook.com/EburyFintech","instagram":"https://www.instagram.com/ebury_fintech","linkedin":"https://www.linkedin.com/company/ebury","x":"https://twitter.com/Ebury_Fintech"},"links":[{"items":[{"label":"Ebury.com","href":"https://ebury.com/"},{"label":"Legal","href":"https://ebury.com/legal"},{"label":"Privacy Notice","href":"https://ebury.com/legal/privacy-notice"},{"label":"Cookie Notice","href":"https://ebury.com/legal/cookie-notice"}]}]},"integrations":{"ga4":{"measurementId":"G-4851W0ZHR1"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ebury","hasAudioNarration":false,"actualSubdomain":"ebury","customDomains":["docs.ebury.com"],"gitSource":{"type":"github","owner":"ebury","repo":"ebury-api-mintlify-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afac9e014079de35bcc6ba8","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":105},{"language":"default","tag":"Endpoints","count":84},{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"Data models","count":16},{"language":"default","tag":"Getting started","count":11},{"language":"default","tag":"Ebury payments","count":8},{"language":"default","tag":"Account details","count":7},{"language":"default","tag":"OAuth2.0","count":7},{"language":"default","tag":"Payments","count":7},{"language":"default","tag":"Statements","count":7}],"searchSettings":{"maxResults":12}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/contact-models","slug":"/api/contact-models","pageMetadata":{"title":"Contact Models","description":"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.","href":"/api/contact-models"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`contact`,children:`Contact`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`32`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`32`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"first_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"last_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email_address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"work_contact_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"home_contact_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mobile_contact_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"address_line_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"address_line_2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"city\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"post_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"password_reset_required\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"language\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"locale\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"time_zone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_online_access\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_authorise_payments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_make_same_currency_payments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_make_independent_payments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_beneficiaries\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_beneficiaries_groups\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_contacts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_fix_forwards\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_multipayments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_payments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_permissions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_trade\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"contact_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`This model is a representation of a contact.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Full name of the contact`})}),`\n`,_jsx(ResponseField,{name:`first_name`,type:`string`,id:`param-first-name`,children:_jsx(_components.p,{children:`First name of the contact`})}),`\n`,_jsx(ResponseField,{name:`last_name`,type:`string`,id:`param-last-name`,children:_jsx(_components.p,{children:`Last name of the contact`})}),`\n`,_jsx(ResponseField,{name:`email_address`,type:`string`,id:`param-email-address`,children:_jsx(_components.p,{children:`Always present. Email address/username of the contact`})}),`\n`,_jsx(ResponseField,{name:`work_contact_number`,type:`string`,id:`param-work-contact-number`,children:_jsx(_components.p,{children:`The work contact number of the contact`})}),`\n`,_jsx(ResponseField,{name:`home_contact_number`,type:`string`,id:`param-home-contact-number`,children:_jsx(_components.p,{children:`The home contact number of the contact`})}),`\n`,_jsx(ResponseField,{name:`mobile_contact_number`,type:`string`,id:`param-mobile-contact-number`,children:_jsx(_components.p,{children:`The mobile contact number of the contact`})}),`\n`,_jsx(ResponseField,{name:`address_line_1`,type:`string`,id:`param-address-line-1`,children:_jsx(_components.p,{children:`The first address line of the contact`})}),`\n`,_jsx(ResponseField,{name:`address_line_2`,type:`string`,id:`param-address-line-2`,children:_jsx(_components.p,{children:`The second address line of the contact`})}),`\n`,_jsx(ResponseField,{name:`city`,type:`string`,id:`param-city`,children:_jsx(_components.p,{children:`The city name of the contact`})}),`\n`,_jsx(ResponseField,{name:`country_code`,type:`string`,id:`param-country-code`,children:_jsx(_components.p,{children:`Country as ISO 3166 two-character code`})}),`\n`,_jsx(ResponseField,{name:`country_name`,type:`string`,id:`param-country-name`,children:_jsx(_components.p,{children:`Full name of the country`})}),`\n`,_jsx(ResponseField,{name:`post_code`,type:`string`,id:`param-post-code`,children:_jsx(_components.p,{children:`The postcode of the contact`})}),`\n`,_jsx(ResponseField,{name:`password_reset_required`,type:`boolean`,id:`param-password-reset-required`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` if contact needs to reset their password, `,_jsx(_components.code,{children:`false`}),` otherwise`]})}),`\n`,_jsx(ResponseField,{name:`language`,type:`string`,id:`param-language`,children:_jsx(_components.p,{children:`Language expressed as ISO 639-1 two-character code`})}),`\n`,_jsx(ResponseField,{name:`locale`,type:`string`,id:`param-locale`,children:_jsx(_components.p,{children:`Locale expressed as ISO 639-1 two-character code`})}),`\n`,_jsx(ResponseField,{name:`time_zone`,type:`string`,id:`param-time-zone`,children:_jsx(_components.p,{children:`The time zone of the contact`})}),`\n`,_jsx(ResponseField,{name:`has_online_access`,type:`boolean`,id:`param-has-online-access`,children:_jsx(_components.p,{children:`Contact has access to Ebury Online`})}),`\n`,_jsx(ResponseField,{name:`can_authorise_payments`,type:`boolean`,id:`param-can-authorise-payments`,children:_jsx(_components.p,{children:`Contact can authorise payments`})}),`\n`,_jsx(ResponseField,{name:`can_make_same_currency_payments`,type:`boolean`,id:`param-can-make-same-currency-payments`,children:_jsx(_components.p,{children:`Contact can create trades and assign same currency payments`})}),`\n`,_jsx(ResponseField,{name:`can_make_independent_payments`,type:`boolean`,id:`param-can-make-independent-payments`,children:_jsx(_components.p,{children:`Contact can make independent payments`})}),`\n`,_jsx(ResponseField,{name:`can_manage_beneficiaries`,type:`boolean`,id:`param-can-manage-beneficiaries`,children:_jsx(_components.p,{children:`Contact can manage beneficiaries`})}),`\n`,_jsx(ResponseField,{name:`can_manage_beneficiaries_groups`,type:`boolean`,id:`param-can-manage-beneficiaries-groups`,children:_jsx(_components.p,{children:`Contact can manage beneficiaries groups`})}),`\n`,_jsx(ResponseField,{name:`can_manage_contacts`,type:`boolean`,id:`param-can-manage-contacts`,children:_jsx(_components.p,{children:`Contact can manage contacts`})}),`\n`,_jsx(ResponseField,{name:`can_manage_fix_forwards`,type:`boolean`,id:`param-can-manage-fix-forwards`,children:_jsx(_components.p,{children:`Contact can manage fixed forwards`})}),`\n`,_jsx(ResponseField,{name:`can_manage_multipayments`,type:`boolean`,id:`param-can-manage-multipayments`,children:_jsx(_components.p,{children:`Contact can manage multipayments`})}),`\n`,_jsx(ResponseField,{name:`can_manage_payments`,type:`boolean`,id:`param-can-manage-payments`,children:_jsx(_components.p,{children:`Contact can manage payments`})}),`\n`,_jsx(ResponseField,{name:`can_manage_permissions`,type:`boolean`,id:`param-can-manage-permissions`,children:_jsx(_components.p,{children:`Contact can manage permissions`})}),`\n`,_jsx(ResponseField,{name:`can_trade`,type:`boolean`,id:`param-can-trade`,children:_jsx(_components.p,{children:`Contact can execute spot trades`})}),`\n`,_jsx(ResponseField,{name:`contact_id`,type:`string`,id:`param-contact-id`,children:_jsx(_components.p,{children:`Unique identifier for the Contact`})}),`\n`,_jsx(Heading,{level:`2`,id:`contactupdate`,children:`ContactUpdate`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`16`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"language\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"locale\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"time_zone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_online_access\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_authorise_payments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_make_same_currency_payments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_beneficiaries\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_beneficiaries_groups\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_contacts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_fix_forwards\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_multipayments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_payments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_manage_permissions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"can_trade\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`This model is a representation of the updateable data of a contact.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`language`,type:`string`,id:`param-language-1`,children:_jsx(_components.p,{children:`Language expressed as ISO 639-1 two-character code`})}),`\n`,_jsx(ResponseField,{name:`locale`,type:`string`,id:`param-locale-1`,children:_jsx(_components.p,{children:`Locale expressed as ISO 639-1 two-character code`})}),`\n`,_jsx(ResponseField,{name:`time_zone`,type:`string`,id:`param-time-zone-1`,children:_jsx(_components.p,{children:`The time zone of the contact`})}),`\n`,_jsx(ResponseField,{name:`has_online_access`,type:`boolean`,id:`param-has-online-access-1`,children:_jsx(_components.p,{children:`Contact has access to Ebury Online`})}),`\n`,_jsx(ResponseField,{name:`can_authorise_payments`,type:`boolean`,id:`param-can-authorise-payments-1`,children:_jsx(_components.p,{children:`Contact can authorise payments`})}),`\n`,_jsx(ResponseField,{name:`can_make_same_currency_payments`,type:`boolean`,id:`param-can-make-same-currency-payments-1`,children:_jsx(_components.p,{children:`Contact can create trades and assign same currency payments`})}),`\n`,_jsx(ResponseField,{name:`can_manage_beneficiaries`,type:`boolean`,id:`param-can-manage-beneficiaries-1`,children:_jsx(_components.p,{children:`Contact can manage beneficiaries`})}),`\n`,_jsx(ResponseField,{name:`can_manage_beneficiaries_groups`,type:`boolean`,id:`param-can-manage-beneficiaries-groups-1`,children:_jsx(_components.p,{children:`Contact can manage beneficiaries groups`})}),`\n`,_jsx(ResponseField,{name:`can_manage_contacts`,type:`boolean`,id:`param-can-manage-contacts-1`,children:_jsx(_components.p,{children:`Contact can manage contacts`})}),`\n`,_jsx(ResponseField,{name:`can_manage_fix_forwards`,type:`boolean`,id:`param-can-manage-fix-forwards-1`,children:_jsx(_components.p,{children:`Contact can manage fixed forwards`})}),`\n`,_jsx(ResponseField,{name:`can_manage_multipayments`,type:`boolean`,id:`param-can-manage-multipayments-1`,children:_jsx(_components.p,{children:`Contact can manage multipayments`})}),`\n`,_jsx(ResponseField,{name:`can_manage_payments`,type:`boolean`,id:`param-can-manage-payments-1`,children:_jsx(_components.p,{children:`Contact can manage payments`})}),`\n`,_jsx(ResponseField,{name:`can_manage_permissions`,type:`boolean`,id:`param-can-manage-permissions-1`,children:_jsx(_components.p,{children:`Contact can manage permissions`})}),`\n`,_jsx(ResponseField,{name:`can_trade`,type:`boolean`,id:`param-can-trade-1`,children:_jsx(_components.p,{children:`Contact can execute trades`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Contact Models","description":"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.","href":"/api/contact-models"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Contact","slug":"contact","depth":2,"children":[]},{"title":"ContactUpdate","slug":"contactupdate","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ebury/0f25bc0ed81b3628/statsig.js","/_mintlify/custom/ebury/05cc4dab1f4ee49a/legacy-anchors.js"],"subdomain":"ebury","siteName":"Ebury","title":"Contact Models - Ebury","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api/contact-models","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T07:16:18.880Z","originalFileLocation":"api/contact-models.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ebury\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Contact Models - Ebury\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ebury\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ebury.com/api/contact-models\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ebury.mintlify.site/_mintlify/api/og/v2?division=Data+models\u0026amp;title=Contact+Models\u0026amp;description=Reference+for+Ebury+Contacts+API+data+models%2C+including+the+Contact+profile%2C+its+permissions+and+the+ContactUpdate+request+body.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=410f6a54d8387a8528b9c36e515a8dd9fce7dbe9d41258d91d7f52f6f34f018d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Contact Models - Ebury\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ebury.mintlify.site/_mintlify/api/og/v2?division=Data+models\u0026amp;title=Contact+Models\u0026amp;description=Reference+for+Ebury+Contacts+API+data+models%2C+including+the+Contact+profile%2C+its+permissions+and+the+ContactUpdate+request+body.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=410f6a54d8387a8528b9c36e515a8dd9fce7dbe9d41258d91d7f52f6f34f018d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ebury\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#73B0CA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ebury.com/api/contact-models\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/contact-models.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ebury.com/#organization\",\"name\":\"Ebury\",\"url\":\"https://docs.ebury.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/light.svg?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=171beecd1c422bb5a896ebdf7a2bf872\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ebury.com#website\",\"name\":\"Ebury\",\"url\":\"https://docs.ebury.com\",\"publisher\":{\"@id\":\"https://docs.ebury.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ebury.com/api/contact-models#webpage\",\"url\":\"https://docs.ebury.com/api/contact-models\",\"name\":\"Contact Models\",\"description\":\"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.\",\"dateModified\":\"2026-10-16T07:16:18.880Z\",\"isPartOf\":{\"@id\":\"https://docs.ebury.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ebury.com/api/contact-models#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ebury.com/api/contact-models#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data models\",\"item\":\"https://docs.ebury.com/api/account-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Contact Models\",\"item\":\"https://docs.ebury.com/api/contact-models\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ebury.com/api/contact-models#article\",\"headline\":\"Contact Models\",\"name\":\"Contact Models\",\"description\":\"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.\",\"url\":\"https://docs.ebury.com/api/contact-models\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ebury.com/api/contact-models#webpage\"},\"dateModified\":\"2026-10-16T07:16:18.880Z\",\"publisher\":{\"@id\":\"https://docs.ebury.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ebury.com#website\"}}]}\u003c/script>","agentPointerHref":"/api/contact-models.md","siteName":"Ebury","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/introduction"}]},{"tab":"API Reference","versions":[{"version":"v1","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Getting Started","href":"/api/getting-started"},{"title":"Authentication","href":"/api/authentication"},{"title":"Example Workflow","href":"/api/example-workflow"},{"title":"Webhook notifications","href":"/api/webhooks"}]},{"group":"Endpoints","pages":[{"group":"OAuth2.0","pages":[{"title":"Authenticate","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /authenticate","href":"/v1/api-reference/oauth20/authenticate"},{"title":"Authenticate","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /authenticate","href":"/v1/api-reference/oauth20/authenticate-1"},{"title":"Available contacts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /info/available-contacts","href":"/v1/api-reference/oauth20/available-contacts"},{"title":"Login","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /login","href":"/v1/api-reference/oauth20/login"},{"title":"Send verification code","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /send-verification-code","href":"/v1/api-reference/oauth20/send-verification-code"},{"title":"Token","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /token","href":"/v1/api-reference/oauth20/token"},{"title":"Verify","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /verify","href":"/v1/api-reference/oauth20/verify"}]},{"group":"Account details","pages":[{"title":"Get the list of account details of the referred client","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /account-details","href":"/v1/api-reference/account-details/get-the-list-of-account-details-of-the-referred-client"},{"title":"Get all the account details (pooled, virtual, segregated)","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /account-details/all","href":"/v1/api-reference/account-details/get-all-the-account-details-pooled-virtual-segregated"},{"title":"Retrieve the account details PDF","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /account-details/pdf","href":"/v1/api-reference/account-details/retrieve-the-account-details-pdf"},{"title":"Request a Dedicated account for a currency+country pair.","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /account-details/request","href":"/v1/api-reference/account-details/request-a-dedicated-account-for-a-currency+country-pair"},{"title":"Assign a new Virtual account for a currency","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /account-details/virtual/{currency}","href":"/v1/api-reference/account-details/assign-a-new-virtual-account-for-a-currency"},{"title":"Update the alias of an account details","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /account-details/{account_details_id}","href":"/v1/api-reference/account-details/update-the-alias-of-an-account-details"},{"title":"Mark the account as primary (default) for its holder and currency","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /account-details/{account_details_id}/make-default","href":"/v1/api-reference/account-details/mark-the-account-as-primary-default-for-its-holder-and-currency"}]},{"group":"Accounts","pages":[{"title":"Retrieve a list of accounts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts","href":"/v1/api-reference/accounts/retrieve-a-list-of-accounts"},{"title":"Retrieve currency accounts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/currency-accounts","href":"/v1/api-reference/accounts/retrieve-currency-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}","href":"/v1/api-reference/accounts/get-an-account"},{"title":"Get funding account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /funding-account","href":"/v1/api-reference/accounts/get-funding-account"}]},{"group":"Balances","pages":[{"title":"Get a balance for a single account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/balances","href":"/v1/api-reference/balances/get-a-balance-for-a-single-account"},{"title":"Retrieve a list of the client's balances","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /balances","href":"/v1/api-reference/balances/retrieve-a-list-of-the-clients-balances"}]},{"group":"Statements Create","pages":[{"title":"Create statement file for an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /accounts/{account_id}/statements/file","href":"/v1/api-reference/statements-create/create-statement-file-for-an-account"}]},{"group":"Statement Fetch","pages":[{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/statements/{statement_id}/file","href":"/v1/api-reference/statement-fetch/get-an-account"}]},{"group":"Transactions","pages":[{"title":"Get transactions for a single account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/transactions","href":"/v1/api-reference/transactions/get-transactions-for-a-single-account"},{"title":"Get a single transactions for an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/transactions/{transaction_id}","href":"/v1/api-reference/transactions/get-a-single-transactions-for-an-account"},{"title":"Get transactions for all client accounts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /transactions","href":"/v1/api-reference/transactions/get-transactions-for-all-client-accounts"}]},{"group":"Approvals Workflow","pages":[{"title":"Get the Approvals Workflow configuration","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /approvals-workflow/config","href":"/v1/api-reference/approvals-workflow/get-the-approvals-workflow-configuration"},{"title":"Update the Approvals Workflow configuration","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /approvals-workflow/config","href":"/v1/api-reference/approvals-workflow/update-the-approvals-workflow-configuration"},{"title":"Get the Approvals Workflow settings","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /approvals-workflow/settings","href":"/v1/api-reference/approvals-workflow/get-the-approvals-workflow-settings"},{"title":"Update the Approvals Workflow settings","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /approvals-workflow/settings","href":"/v1/api-reference/approvals-workflow/update-the-approvals-workflow-settings"}]},{"group":"Beneficiaries","pages":[{"title":"Get beneficiaries","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /beneficiaries","href":"/v1/api-reference/beneficiaries/get-beneficiaries"},{"title":"Create a new beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /beneficiaries","href":"/v1/api-reference/beneficiaries/create-a-new-beneficiary"},{"title":"Get a beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /beneficiaries/{beneficiary_id}","href":"/v1/api-reference/beneficiaries/get-a-beneficiary"},{"title":"Delete a beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json delete /beneficiaries/{beneficiary_id}","href":"/v1/api-reference/beneficiaries/delete-a-beneficiary"},{"title":"Update a beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /beneficiaries/{beneficiary_id}","href":"/v1/api-reference/beneficiaries/update-a-beneficiary"}]},{"group":"Clients","pages":[{"title":"Get clients","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /clients","href":"/v1/api-reference/clients/get-clients"}]},{"group":"Contacts","pages":[{"title":"Get contacts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /contacts","href":"/v1/api-reference/contacts/get-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /contacts/{contact_id}","href":"/v1/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /contacts/{contact_id}","href":"/v1/api-reference/contacts/update-a-contact"}]},{"group":"Credit Conditions","pages":[{"title":"Get credit conditions limit","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /credit-conditions/limit/pad","href":"/v1/api-reference/credit-conditions/get-credit-conditions-limit"}]},{"group":"Currencies","pages":[{"title":"Retrieve a list of the client's currencies","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /currencies","href":"/v1/api-reference/currencies/retrieve-a-list-of-the-clients-currencies"}]},{"group":"Documents","pages":[{"title":"Get a document","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /documents","href":"/v1/api-reference/documents/get-a-document"}]},{"group":"Drawdowns","pages":[{"title":"Create a drawdown","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /drawdowns","href":"/v1/api-reference/drawdowns/create-a-drawdown"},{"title":"Get available drawdown margin","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /drawdowns/available_margin","href":"/v1/api-reference/drawdowns/get-available-drawdown-margin"}]},{"group":"Mass Beneficiaries","pages":[{"title":"Retrieve all mass beneficiary submissions","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries","href":"/v1/api-reference/mass-beneficiaries/retrieve-all-mass-beneficiary-submissions"},{"title":"Create a mass beneficiary instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /mass-beneficiaries","href":"/v1/api-reference/mass-beneficiaries/create-a-mass-beneficiary-instruction"},{"title":"Retrieve a mass beneficiary submission","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries/{mass_beneficiary_id}","href":"/v1/api-reference/mass-beneficiaries/retrieve-a-mass-beneficiary-submission"},{"title":"Retrieve the beneficiary creation errors of a mass beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries/{mass_beneficiary_id}/errors","href":"/v1/api-reference/mass-beneficiaries/retrieve-the-beneficiary-creation-errors-of-a-mass-beneficiary"},{"title":"Retrieve the beneficiaries created by a mass beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries/{mass_beneficiary_id}/beneficiaries","href":"/v1/api-reference/mass-beneficiaries/retrieve-the-beneficiaries-created-by-a-mass-beneficiary"}]},{"group":"Mass Payments","pages":[{"title":"Fetch mass payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments","href":"/v1/api-reference/mass-payments/fetch-mass-payments"},{"title":"Create a mass payment instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /mass-payments","href":"/v1/api-reference/mass-payments/create-a-mass-payment-instruction"},{"title":"Confirm a mass payment instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /mass-payments/{mass_payment_id}/confirm","href":"/v1/api-reference/mass-payments/confirm-a-mass-payment-instruction"},{"title":"Fetch the payment instructions with errors for a mass payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments/{mass_payment_id}/errors","href":"/v1/api-reference/mass-payments/fetch-the-payment-instructions-with-errors-for-a-mass-payment"},{"title":"Fetch the funding account of a mass payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments/{mass_payment_id}/funding-account","href":"/v1/api-reference/mass-payments/fetch-the-funding-account-of-a-mass-payment"},{"title":"Fetch the payment instructions submitted for a mass payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments/{mass_payment_id}/payments-received","href":"/v1/api-reference/mass-payments/fetch-the-payment-instructions-submitted-for-a-mass-payment"}]},{"group":"Metadata","pages":[{"title":"Get beneficiary metadata","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /metadata/beneficiary","href":"/v1/api-reference/metadata/get-beneficiary-metadata"},{"title":"Get currency metadata","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /metadata/currency","href":"/v1/api-reference/metadata/get-currency-metadata"}]},{"group":"Multi Payments","pages":[{"title":"Create a multi payment instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /multipayments","href":"/v1/api-reference/multi-payments/create-a-multi-payment-instruction"},{"title":"Rejects a multi payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json delete /multipayments/{multipayment_id}","href":"/v1/api-reference/multi-payments/rejects-a-multi-payment"},{"title":"Accept a multi payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /multipayments/{multipayment_id}","href":"/v1/api-reference/multi-payments/accept-a-multi-payment"}]},{"group":"Payments","pages":[{"title":"Search or retrieve payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments","href":"/v1/api-reference/payments/search-or-retrieve-payments"},{"title":"Create one or more payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /payments","href":"/v1/api-reference/payments/create-one-or-more-payments"},{"title":"Get the fee of payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments/fees","href":"/v1/api-reference/payments/get-the-fee-of-payments"},{"title":"Get the estimate fee of payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments/fees_estimate","href":"/v1/api-reference/payments/get-the-estimate-fee-of-payments"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments/{payment_id}","href":"/v1/api-reference/payments/retrieve-a-payment"},{"title":"Delete a payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json delete /payments/{payment_id}","href":"/v1/api-reference/payments/delete-a-payment"},{"title":"Authorise or reject a payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /payments/{payment_id}","href":"/v1/api-reference/payments/authorise-or-reject-a-payment"}]},{"group":"Ping","pages":[{"title":"Test connectivity","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /ping","href":"/v1/api-reference/ping/test-connectivity"},{"title":"Test connectivity","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /ping","href":"/v1/api-reference/ping/test-connectivity-1"}]},{"group":"Quotes","pages":[{"title":"Get an estimate or firm quote","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /quotes","href":"/v1/api-reference/quotes/get-an-estimate-or-firm-quote"},{"title":"Get the availability for FX markets","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /quotes/fx-availability","href":"/v1/api-reference/quotes/get-the-availability-for-fx-markets"}]},{"group":"Statements","pages":[{"title":"List statement requests","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /statements","href":"/v1/api-reference/statements/list-statement-requests"},{"title":"Create a statement request","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements","href":"/v1/api-reference/statements/create-a-statement-request"},{"title":"Request accounts statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/accounts","href":"/v1/api-reference/statements/request-accounts-statement-via-email"},{"title":"Request incoming funds statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/incoming-funds","href":"/v1/api-reference/statements/request-incoming-funds-statement-via-email"},{"title":"Request MT940 statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/mt940","href":"/v1/api-reference/statements/request-mt940-statement-via-email"},{"title":"Request trades statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/trades","href":"/v1/api-reference/statements/request-trades-statement-via-email"},{"title":"Get statement details","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /statements/{statement_id}","href":"/v1/api-reference/statements/get-statement-details"}]},{"group":"TrustedAuthentication","pages":[{"title":"Token for a Contact","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /token/{contact_id}","href":"/v1/api-reference/trustedauthentication/token-for-a-contact"}]},{"group":"Trades","pages":[{"title":"Get all trades","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /trades","href":"/v1/api-reference/trades/get-all-trades"},{"title":"Create a Trade","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /trades","href":"/v1/api-reference/trades/create-a-trade"},{"title":"Get a trade","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /trades/{trade_id}","href":"/v1/api-reference/trades/get-a-trade"}]},{"group":"VoP","pages":[{"title":"Run a standalone Verification of Payee check for a list of beneficiaries","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /vop","href":"/v1/api-reference/vop/run-a-standalone-verification-of-payee-check-for-a-list-of-beneficiaries"}]},{"group":"Webhooks","pages":[{"title":"Execute a GraphQL query over the webhooks API","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /webhooks/graphql","href":"/v1/api-reference/webhooks/execute-a-graphql-query-over-the-webhooks-api"},{"title":"Ping a subscription","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /webhooks/ping/{subscription_id}","href":"/v1/api-reference/webhooks/ping-a-subscription"}]}]},{"group":"Data models","pages":[{"title":"Account Models","href":"/api/account-models"},{"title":"Account Details Model","href":"/api/account-details-model"},{"title":"Balance Models","href":"/api/balance-models"},{"title":"Beneficiary Models","description":"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.","href":"/api/beneficiary-models"},{"title":"Contact Models","href":"/api/contact-models"},{"title":"Currency Models","description":"Reference for Ebury Currencies API data models, including Currency, CurrencyInfo, TradeType and payment cut-off times.","href":"/api/currency-models"},{"title":"Mass Beneficiary Models","href":"/api/mass-beneficiary-models"},{"title":"Mass Payment Model","href":"/api/mass-payment-model"},{"title":"Multipayment models","href":"/api/multipayment-models"},{"title":"Payment Instructions Model","href":"/api/payment-instructions-model"},{"title":"Payment Models","href":"/api/payment-models"},{"title":"Statements Models","href":"/api/statements-models"},{"title":"Trade Models","href":"/api/trade-models"},{"title":"Transaction Models","href":"/api/transaction-models"},{"group":"Purpose of payment codes","pages":[{"title":"China Purpose of Payment Codes","href":"/api/resources/chn-pop-codes"},{"title":"UAE Purpose of Payment Codes","href":"/api/resources/uae-pop-codes"}]}]}]}]}]},"basePath":"","title":"Contact Models - Ebury","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}