Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a destination.
type: individual needs firstName and lastName; type: business needs legalName. displayName is derived from them.
relationship is one of vendor, supplier, customer or employee.
identification is optional. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. Document numbers are passed to the payment network and not stored: reads return the type, country and last four.
Your account must be verified first (409 NOT_VERIFIED otherwise).
An access token (at_test_… or at_live_…) from POST https://idp.talescria.com/oauth/token.
Headers
Idempotency-Key
string
required
A unique key for this operation. Send the same key when you retry it. Kept for 24 hours.
Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_\-:.]+$
Body
application/json
type
enum<string>
required
Decides which name fields are required.
Available options:
individual,
business
relationship
enum<string>
required
How you're related to the recipient: vendor, supplier, customer or employee.
Available options:
vendor,
supplier,
customer,
employee
email
string<email>
required
Maximum string length: 320
address
object
required
Show child attributes
firstName
string
Required for an individual.
Maximum string length: 100
lastName
string
Required for an individual.
Maximum string length: 100
legalName
string
Required for a business.
Maximum string length: 200
tradingName
string
What the business is known as, if that differs from its legal name.
Maximum string length: 200
phone
string
Maximum string length: 32
identification
object[]
Identifying documents. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. The number is passed to the payment network and not stored by Talescria: reads return the type, the issuing country and the last four digits.
Maximum array length: 5
Show child attributes
nickname
string
A label for the recipient at the provider, when their name is not what you call them.
Maximum string length: 200
Response
Created. destinations is an empty array.
recipient
object
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Talescria","colors":{"primary":"#FF6600","light":"#FF9A32","dark":"#E65C00"},"logo":{"light":"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/logo/light.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=1783c16919171f6b1f28c928fecc3a63","dark":"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/logo/dark.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=bdeff1708e4347fc28b219c66345aefc","href":"https://talescria.com"},"favicon":"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/favicon.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=bc42be5a40be869a36b295ba829bcf39","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://talescria.com/login"}},"footer":{"socials":{"website":"https://talescria.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"talescria","hasAudioNarration":false,"actualSubdomain":"talescria","customDomains":["docs.talescria.com"],"gitSource":{"type":"github","owner":"talescrya","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6afc888f097841e8df51a72b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afc8900097841e8df51b73a","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":39},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Invoices","count":10},{"language":"default","tag":"Recipients","count":6},{"language":"default","tag":"Core concepts","count":5},{"language":"default","tag":"Customers","count":5},{"language":"default","tag":"Payments","count":5},{"language":"default","tag":"Pay out","count":4},{"language":"default","tag":"Get paid","count":4},{"language":"default","tag":"Payment links","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/recipients/create-a-recipient","slug":"/api-reference/recipients/create-a-recipient","pageMetadata":{"title":"Create a recipient","description":"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a [destination](/api-reference/recipients/add-a-destination).\n\n- `type: individual` needs `firstName` and `lastName`; `type: business` needs `legalName`. `displayName` is derived from them.\n- `relationship` is one of `vendor`, `supplier`, `customer` or `employee`.\n- `identification` is optional. A business may only be identified by `business_registration`; an individual by `passport`, `drivers_license` or `national_id`. Document numbers are passed to the payment network and not stored: reads return the type, country and last four.\n\nYour account must be verified first (`409 NOT_VERIFIED` otherwise).\n\nRequires the `recipients:write` scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/recipients","href":"/api-reference/recipients/create-a-recipient","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a \", _jsx(_components.a, {\n href: \"/api-reference/recipients/add-a-destination\",\n children: \"destination\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"type: individual\"\n }), \" needs \", _jsx(_components.code, {\n children: \"firstName\"\n }), \" and \", _jsx(_components.code, {\n children: \"lastName\"\n }), \"; \", _jsx(_components.code, {\n children: \"type: business\"\n }), \" needs \", _jsx(_components.code, {\n children: \"legalName\"\n }), \". \", _jsx(_components.code, {\n children: \"displayName\"\n }), \" is derived from them.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"relationship\"\n }), \" is one of \", _jsx(_components.code, {\n children: \"vendor\"\n }), \", \", _jsx(_components.code, {\n children: \"supplier\"\n }), \", \", _jsx(_components.code, {\n children: \"customer\"\n }), \" or \", _jsx(_components.code, {\n children: \"employee\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"identification\"\n }), \" is optional. A business may only be identified by \", _jsx(_components.code, {\n children: \"business_registration\"\n }), \"; an individual by \", _jsx(_components.code, {\n children: \"passport\"\n }), \", \", _jsx(_components.code, {\n children: \"drivers_license\"\n }), \" or \", _jsx(_components.code, {\n children: \"national_id\"\n }), \". Document numbers are passed to the payment network and not stored: reads return the type, country and last four.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Your account must be verified first (\", _jsx(_components.code, {\n children: \"409 NOT_VERIFIED\"\n }), \" otherwise).\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"recipients:write\"\n }), \" scope.\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a recipient","description":"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a [destination](/api-reference/recipients/add-a-destination).\n\n- `type: individual` needs `firstName` and `lastName`; `type: business` needs `legalName`. `displayName` is derived from them.\n- `relationship` is one of `vendor`, `supplier`, `customer` or `employee`.\n- `identification` is optional. A business may only be identified by `business_registration`; an individual by `passport`, `drivers_license` or `national_id`. Document numbers are passed to the payment network and not stored: reads return the type, country and last four.\n\nYour account must be verified first (`409 NOT_VERIFIED` otherwise).\n\nRequires the `recipients:write` scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/recipients","href":"/api-reference/recipients/create-a-recipient","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createRecipient","tags":["Recipients"],"summary":"Create a recipient","description":"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a [destination](/api-reference/recipients/add-a-destination).\n\n- `type: individual` needs `firstName` and `lastName`; `type: business` needs `legalName`. `displayName` is derived from them.\n- `relationship` is one of `vendor`, `supplier`, `customer` or `employee`.\n- `identification` is optional. A business may only be identified by `business_registration`; an individual by `passport`, `drivers_license` or `national_id`. Document numbers are passed to the payment network and not stored: reads return the type, country and last four.\n\nYour account must be verified first (`409 NOT_VERIFIED` otherwise).\n\nRequires the `recipients:write` scope.","security":["bad50adc-8a4f-4cd6-adca-d0a8f8ff83f1"],"x-scope":"recipients:write","parameters":["3d524591-6e23-4286-a9b5-8f9d3d177b50"],"requestBody":"933bfb24-93f1-4204-b250-48b99973b19f","responses":{"201":"3d06b696-7229-48d5-873c-cf185de3d0cf","400":"cb6981c2-972a-45dd-9ff8-cefac84f25d0","401":"144764fb-7b6a-42f0-8f7c-0c1b64579662","403":"fe486f21-79f5-4084-ad67-28768f5f270f","409":"b5a2e471-fd56-440c-aa46-6e7304030aad","422":"7c1d40bc-80d4-438a-b846-09b74d044910","429":"c83e6229-a82c-4091-93d4-025e41d3b06f","500":"ef7485b2-487c-4828-b8c8-354ae69050fe","502":"cb7c4a81-5df6-42b6-8627-53dd9eddd668","503":"d5377e1e-57c4-4006-920c-7bcfc06f56bc"},"method":"post","type":"path","servers":["6983571a-ec7d-43ee-b1dd-d63b6c85ac00"],"path":"/v1/recipients","baseUrlOptions":["https://api.talescria.com"],"title":"Create a recipient","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3d524591-6e23-4286-a9b5-8f9d3d177b50":{"name":"Idempotency-Key","in":"header","required":true,"description":"A unique key for this operation. Send the same key when you retry it. Kept for 24 hours.","schema":{"type":"string","minLength":8,"maxLength":255,"pattern":"^[A-Za-z0-9_\\-:.]+$","isRequired":true,"description":"A unique key for this operation. Send the same key when you retry it. Kept for 24 hours.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","relationship","email","address"],"properties":{"type":{"type":"string","enum":["individual","business"],"description":"Decides which name fields are required.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"relationship":{"type":"string","enum":["vendor","supplier","customer","employee"],"description":"How you're related to the recipient: `vendor`, `supplier`, `customer` or `employee`.","isRequired":true,"uniqueKey":"relationship","typeLabel":"enum\u003cstring>"},"email":{"type":"string","format":"email","maxLength":320,"isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"address":{"type":"object","required":["line1","city","stateOrProvince","postalCode","country"],"properties":{"line1":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"address.line1","typeLabel":"string"},"city":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"address.city","typeLabel":"string"},"stateOrProvince":{"type":"string","maxLength":100,"description":"Required. The payment network takes a recipient without one, then refuses every payment to them.","isRequired":true,"uniqueKey":"address.stateOrProvince","typeLabel":"string"},"postalCode":{"type":"string","maxLength":32,"isRequired":true,"uniqueKey":"address.postalCode","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2","isRequired":true,"uniqueKey":"address.country","typeLabel":"string"},"line2":{"type":"string","maxLength":200,"uniqueKey":"address.line2","typeLabel":"string"}},"isRequired":true,"uniqueKey":"address","typeLabel":"object"},"firstName":{"type":"string","maxLength":100,"description":"Required for an individual.","uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","maxLength":100,"description":"Required for an individual.","uniqueKey":"lastName","typeLabel":"string"},"legalName":{"type":"string","maxLength":200,"description":"Required for a business.","uniqueKey":"legalName","typeLabel":"string"},"tradingName":{"type":"string","maxLength":200,"description":"What the business is known as, if that differs from its legal name.","uniqueKey":"tradingName","typeLabel":"string"},"phone":{"type":"string","maxLength":32,"uniqueKey":"phone","typeLabel":"string"},"identification":{"type":"array","maxItems":5,"description":"Identifying documents. A business may only be identified by `business_registration`; an individual by `passport`, `drivers_license` or `national_id`. The `number` is passed to the payment network and not stored by Talescria: reads return the type, the issuing country and the last four digits.","items":{"type":"object","required":["type","number","issuingCountry"],"properties":{"type":{"type":"string","enum":["passport","drivers_license","national_id","business_registration"],"isRequired":true,"uniqueKey":"identification.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"identification.items.[INDEX].number","typeLabel":"string"},"issuingCountry":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2","isRequired":true,"uniqueKey":"identification.items.[INDEX].issuingCountry","typeLabel":"string"}},"uniqueKey":"identification.items.[INDEX]","typeLabel":"object"},"uniqueKey":"identification","typeLabel":"object[]"},"nickname":{"type":"string","maxLength":200,"description":"A label for the recipient at the provider, when their name is not what you call them.","uniqueKey":"nickname","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"person":{"title":"person","summary":"A contractor paid in GBP","value":{"type":"individual","firstName":"Ola","lastName":"Nwosu","relationship":"vendor","email":"[email protected]","address":{"line1":"2261 Curtain Road","city":"London","postalCode":"EC2A 3AY","country":"GB","stateOrProvince":"Greater London"}}},"business":{"title":"business","summary":"A supplier, named by its trading name","value":{"type":"business","legalName":"Domestic Ads Limited","tradingName":"Domestic Ads","relationship":"supplier","email":"[email protected]","address":{"line1":"14 Broad Street","city":"Lagos","postalCode":"101231","country":"NG","stateOrProvince":"Lagos"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"3d06b696-7229-48d5-873c-cf185de3d0cf":{"description":"Created. `destinations` is an empty array.","content":{"application/json":{"schema":{"type":"object","properties":{"recipient":{"type":"object","required":["id","type","displayName","relationship","email","address","createdAt"],"properties":{"id":{"type":"string","example":"rcp_9f2c1e4a7b8d4e0f9a1b2c3d4e5f6071","isRequired":true,"uniqueKey":"recipient.id","typeLabel":"string"},"type":{"type":"string","enum":["individual","business"],"isRequired":true,"uniqueKey":"recipient.type","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"What to render. **Derived**, an individual's two names, or a business's trading name falling back to its legal name, so it can never disagree with the names below. Not accepted as input.","isRequired":true,"uniqueKey":"recipient.displayName","typeLabel":"string"},"relationship":{"type":"string","enum":["vendor","supplier","customer","employee"],"description":"How you're related to the recipient.","isRequired":true,"uniqueKey":"recipient.relationship","typeLabel":"enum\u003cstring>"},"email":{"type":"string","isRequired":true,"uniqueKey":"recipient.email","typeLabel":"string"},"address":{"type":"object","required":["line1","city","stateOrProvince","postalCode","country"],"properties":{"line1":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"recipient.address.line1","typeLabel":"string"},"city":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"recipient.address.city","typeLabel":"string"},"stateOrProvince":{"type":"string","maxLength":100,"description":"Required. The payment network takes a recipient without one, then refuses every payment to them.","isRequired":true,"uniqueKey":"recipient.address.stateOrProvince","typeLabel":"string"},"postalCode":{"type":"string","maxLength":32,"isRequired":true,"uniqueKey":"recipient.address.postalCode","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2","isRequired":true,"uniqueKey":"recipient.address.country","typeLabel":"string"},"line2":{"type":"string","maxLength":200,"uniqueKey":"recipient.address.line2","typeLabel":"string"}},"isRequired":true,"uniqueKey":"recipient.address","typeLabel":"object"},"createdAt":{"type":"integer","format":"int64","description":"Epoch milliseconds.","isRequired":true,"uniqueKey":"recipient.createdAt","typeLabel":"integer\u003cint64>"},"firstName":{"type":"string","uniqueKey":"recipient.firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"recipient.lastName","typeLabel":"string"},"legalName":{"type":"string","uniqueKey":"recipient.legalName","typeLabel":"string"},"tradingName":{"type":"string","uniqueKey":"recipient.tradingName","typeLabel":"string"},"phone":{"type":"string","uniqueKey":"recipient.phone","typeLabel":"string"},"identification":{"type":"array","description":"Which documents identify this recipient, never their numbers. Absent means none were given.","items":{"type":"object","required":["type","issuingCountry","last4"],"properties":{"type":{"type":"string","enum":["passport","drivers_license","national_id","business_registration"],"isRequired":true,"uniqueKey":"recipient.identification.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"issuingCountry":{"type":"string","example":"GB","isRequired":true,"uniqueKey":"recipient.identification.items.[INDEX].issuingCountry","typeLabel":"string"},"last4":{"type":"string","description":"The last four characters of the document number, or the whole thing when it is shorter than four, padding it would invent digits.","example":"5678","isRequired":true,"uniqueKey":"recipient.identification.items.[INDEX].last4","typeLabel":"string"}},"uniqueKey":"recipient.identification.items.[INDEX]","typeLabel":"object"},"uniqueKey":"recipient.identification","typeLabel":"object[]"},"destinations":{"type":"array","items":{"type":"object","required":["id","method","currency"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"recipient.destinations.items.[INDEX].id","typeLabel":"string"},"method":{"type":"string","enum":["bank_transfer","mobile_money","stablecoin","internal_transfer"],"isRequired":true,"uniqueKey":"recipient.destinations.items.[INDEX].method","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","isRequired":true,"uniqueKey":"recipient.destinations.items.[INDEX].currency","typeLabel":"string"},"scheme":{"type":"string","uniqueKey":"recipient.destinations.items.[INDEX].scheme","typeLabel":"string"},"label":{"type":"string","description":"What names the rail to a person, a bank name, or `mpesa`.","example":"HSBC","uniqueKey":"recipient.destinations.items.[INDEX].label","typeLabel":"string"},"last4":{"type":"string","description":"The last four of an account or phone number, or a wallet address truncated at both ends. **This is all there is.** The full details were sent to the provider and are not stored by Talescria, so there is no endpoint that returns them.","example":"0101","uniqueKey":"recipient.destinations.items.[INDEX].last4","typeLabel":"string"},"routing":{"type":"string","description":"Safe to show in full, because it identifies a bank or branch rather than an account, a sort code, a bank code, a BIC.","example":"40-12-76","uniqueKey":"recipient.destinations.items.[INDEX].routing","typeLabel":"string"}},"uniqueKey":"recipient.destinations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"recipient.destinations","typeLabel":"object[]"}},"uniqueKey":"recipient","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"recipient":{"id":"rcp_9f2c1e4a7b8d4e0f9a1b2c3d4e5f6071","type":"individual","displayName":"\u003cstring>","relationship":"vendor","email":"\u003cstring>","address":{"line1":"\u003cstring>","city":"\u003cstring>","stateOrProvince":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>","line2":"\u003cstring>"},"createdAt":123,"firstName":"\u003cstring>","lastName":"\u003cstring>","legalName":"\u003cstring>","tradingName":"\u003cstring>","phone":"\u003cstring>","identification":[{"type":"passport","issuingCountry":"GB","last4":"5678"}],"destinations":[{"id":"\u003cstring>","method":"bank_transfer","currency":"\u003cstring>","scheme":"\u003cstring>","label":"HSBC","last4":"0101","routing":"40-12-76"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"cb6981c2-972a-45dd-9ff8-cefac84f25d0":{"description":"`VALIDATION`: A field is missing or malformed. `message` says which.\n\n`IDEMPOTENCY_KEY_REQUIRED`: This operation needs an `Idempotency-Key` header.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"144764fb-7b6a-42f0-8f7c-0c1b64579662":{"description":"`UNAUTHENTICATED`: The access token is missing, expired or revoked. Get a new token.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fe486f21-79f5-4084-ad67-28768f5f270f":{"description":"`ENVIRONMENT_UNAVAILABLE`: Live mode isn't available until your account is approved.\n\n`INSUFFICIENT_SCOPE`: Your API key lacks the scope this operation needs. The scope is named in `message` and the `WWW-Authenticate` header.\n\n`ENVIRONMENT_MISMATCH`: The request named a different environment from the key's.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b5a2e471-fd56-440c-aa46-6e7304030aad":{"description":"`NOT_VERIFIED`: Your account hasn't finished verification. Finish onboarding, then retry.\n\n`IDEMPOTENCY_IN_PROGRESS`: A request with this `Idempotency-Key` is still running. Retry shortly.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7c1d40bc-80d4-438a-b846-09b74d044910":{"description":"`UNSUPPORTED`: This can't work as asked, for example an unsupported currency, corridor or account. `message` says why.\n\n`IDEMPOTENCY_KEY_REUSED`: This `Idempotency-Key` was used for a different request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c83e6229-a82c-4091-93d4-025e41d3b06f":{"description":"`RATE_LIMITED`: Too many requests. Wait for `Retry-After` seconds.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ef7485b2-487c-4828-b8c8-354ae69050fe":{"description":"`MISCONFIGURED`: Something is wrong on our side. Contact support with the `x-request-id`.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"cb7c4a81-5df6-42b6-8627-53dd9eddd668":{"description":"`UPSTREAM_ERROR`: A service we depend on answered unexpectedly. Retry, and contact support with the `x-request-id` if it persists.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d5377e1e-57c4-4006-920c-7bcfc06f56bc":{"description":"`UPSTREAM_UNAVAILABLE`: Temporarily unavailable. Retry with backoff.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Branch on this, not on `message`. See Errors.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"For people. Wording can change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bad50adc-8a4f-4cd6-adca-d0a8f8ff83f1":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An access token (`at_test_…` or `at_live_…`) from `POST https://idp.talescria.com/oauth/token`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"6983571a-ec7d-43ee-b1dd-d63b6c85ac00":{"url":"https://api.talescria.com","description":"Production (test and live keys)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An access token (`at_test_…` or `at_live_…`) from `POST https://idp.talescria.com/oauth/token`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An access token (`at_test_…` or `at_live_…`) from `POST https://idp.talescria.com/oauth/token`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"talescria","siteName":"Talescria","title":"Create a recipient - Talescria","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T17:04:00.490Z","originalFileLocation":"api-reference/recipients/create-a-recipient.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=\"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a destination. - type: individual needs firstName and lastName; type: business needs legalName. displayName is derived from them. - relationship is one of vendor, supplier, customer or employee. - identification is optional. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. Document numbers are passed to the payment network and not stored: reads return the type, country and last four. Your account must be verified first (409 NOT_VERIFIED otherwise). Requires the recipients:write scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Talescria\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_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/talescria/Y1lJeoVQyIA6Yog1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a recipient - Talescria\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a destination. - type: individual needs firstName and lastName; type: business needs legalName. displayName is derived from them. - relationship is one of vendor, supplier, customer or employee. - identification is optional. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. Document numbers are passed to the payment network and not stored: reads return the type, country and last four. Your account must be verified first (409 NOT_VERIFIED otherwise). Requires the recipients:write scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Talescria\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.talescria.com/api-reference/recipients/create-a-recipient\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://talescria.mintlify.site/_mintlify/api/og/v2?division=Recipients\u0026amp;title=Create+a+recipient\u0026amp;description=Adds+someone+you+pay.+A+recipient+is+who+they+are+%28names%2C+email%2C+address%29%3B+where+to+send+money+is+added+separately+as+a+%5Bdestination%5D%28%2Fapi-reference%2Frecipients%2F\u0026amp;theme=6c6e5c86e601a0971e5ce304\u0026amp;signature=97f35a98ffbe1bf1736434eda5629834d4caf036825327049889b5acdbf08cc9\">\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=\"Create a recipient - Talescria\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a destination. - type: individual needs firstName and lastName; type: business needs legalName. displayName is derived from them. - relationship is one of vendor, supplier, customer or employee. - identification is optional. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. Document numbers are passed to the payment network and not stored: reads return the type, country and last four. Your account must be verified first (409 NOT_VERIFIED otherwise). Requires the recipients:write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://talescria.mintlify.site/_mintlify/api/og/v2?division=Recipients\u0026amp;title=Create+a+recipient\u0026amp;description=Adds+someone+you+pay.+A+recipient+is+who+they+are+%28names%2C+email%2C+address%29%3B+where+to+send+money+is+added+separately+as+a+%5Bdestination%5D%28%2Fapi-reference%2Frecipients%2F\u0026amp;theme=6c6e5c86e601a0971e5ce304\u0026amp;signature=97f35a98ffbe1bf1736434eda5629834d4caf036825327049889b5acdbf08cc9\">\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/talescria/Y1lJeoVQyIA6Yog1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Talescria\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6600\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.talescria.com/api-reference/recipients/create-a-recipient\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/recipients/create-a-recipient.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.talescria.com/#organization\",\"name\":\"Talescria\",\"url\":\"https://docs.talescria.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/talescria/itDUVhw6qT1GpDxp/logo/light.svg?fit=max\u0026auto=format\u0026n=itDUVhw6qT1GpDxp\u0026q=85\u0026s=1783c16919171f6b1f28c928fecc3a63\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.talescria.com#website\",\"name\":\"Talescria\",\"url\":\"https://docs.talescria.com\",\"publisher\":{\"@id\":\"https://docs.talescria.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient#webpage\",\"url\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient\",\"name\":\"Create a recipient\",\"description\":\"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a destination. - type: individual needs firstName and lastName; type: business needs legalName. displayName is derived from them. - relationship is one of vendor, supplier, customer or employee. - identification is optional. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. Document numbers are passed to the payment network and not stored: reads return the type, country and last four. Your account must be verified first (409 NOT_VERIFIED otherwise). Requires the recipients:write scope.\",\"dateModified\":\"2026-11-17T17:04:00.490Z\",\"isPartOf\":{\"@id\":\"https://docs.talescria.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Recipients\",\"item\":\"https://docs.talescria.com/api-reference/recipients/list-recipients\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a recipient\",\"item\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient#apireference\",\"headline\":\"Create a recipient\",\"name\":\"Create a recipient\",\"description\":\"Adds someone you pay. A recipient is who they are (names, email, address); where to send money is added separately as a destination. - type: individual needs firstName and lastName; type: business needs legalName. displayName is derived from them. - relationship is one of vendor, supplier, customer or employee. - identification is optional. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. Document numbers are passed to the payment network and not stored: reads return the type, country and last four. Your account must be verified first (409 NOT_VERIFIED otherwise). Requires the recipients:write scope.\",\"url\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient\",\"mainEntityOfPage\":{\"@id\":\"https://docs.talescria.com/api-reference/recipients/create-a-recipient#webpage\"},\"dateModified\":\"2026-11-17T17:04:00.490Z\",\"publisher\":{\"@id\":\"https://docs.talescria.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.talescria.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Talescria\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Talescria\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/recipients/create-a-recipient.md","siteName":"Talescria","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Authentication","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Get an access token","api":"POST https://idp.talescria.com/oauth/token","href":"/api-reference/get-an-access-token"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Open an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/accounts","href":"/api-reference/accounts/open-an-account"}]},{"group":"Recipients","pages":[{"title":"List recipients","description":"Your recipients, oldest first.\n\n`destinations` is not included in the list. Fetch a single recipient to see where they can be paid.\n\nRequires the `recipients:read` scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/recipients","href":"/api-reference/recipients/list-recipients"},{"title":"Create a recipient","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/recipients","href":"/api-reference/recipients/create-a-recipient"},{"title":"Retrieve a recipient","description":"One recipient, with the destinations they can be paid at.\n\nIf `destinations` is absent, we couldn't load them just now; retry. An empty array means the recipient has no destinations yet.\n\nRequires the `recipients:read` scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/recipients/{recipientId}","href":"/api-reference/recipients/retrieve-a-recipient"},{"title":"Add a destination","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/recipients/{recipientId}/destinations","href":"/api-reference/recipients/add-a-destination"},{"title":"Get destination requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/destination-requirements","href":"/api-reference/recipients/get-destination-requirements"},{"title":"List banks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/banks","href":"/api-reference/recipients/list-banks"}]},{"group":"Payments","pages":[{"title":"List payment reasons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/transfer-reasons","href":"/api-reference/payments/list-payment-reasons"},{"title":"Create an FX quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/fx-quotes","href":"/api-reference/payments/create-an-fx-quote"},{"title":"Retrieve an FX quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/fx-quotes/{quoteId}","href":"/api-reference/payments/retrieve-an-fx-quote"},{"title":"Send a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/transfers","href":"/api-reference/payments/send-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/transfers/{transferId}","href":"/api-reference/payments/retrieve-a-payment"}]},{"group":"Transfers","pages":[{"title":"Quote a transfer between your accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/conversions/quotes","href":"/api-reference/transfers/quote-a-transfer-between-your-accounts"},{"title":"Transfer between your accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/conversions","href":"/api-reference/transfers/transfer-between-your-accounts"},{"title":"Retrieve a transfer between your accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/conversions/{conversionId}","href":"/api-reference/transfers/retrieve-a-transfer-between-your-accounts"}]},{"group":"Payment links","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payment-links","href":"/api-reference/payment-links/list-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payment-links","href":"/api-reference/payment-links/create-a-payment-link"},{"title":"Retrieve a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/payment-links/{linkId}","href":"/api-reference/payment-links/retrieve-a-payment-link"},{"title":"Archive a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/payment-links/{linkId}/archive","href":"/api-reference/payment-links/archive-a-payment-link"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/customers","href":"/api-reference/customers/create-a-customer"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/customers/{customerId}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/customers/{customerId}","href":"/api-reference/customers/update-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/customers/{customerId}","href":"/api-reference/customers/delete-a-customer"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Preview the next invoice number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoices/next-number","href":"/api-reference/invoices/preview-the-next-invoice-number"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoices/{invoiceId}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoices/{invoiceId}/void","href":"/api-reference/invoices/void-an-invoice"},{"title":"Resend an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoices/{invoiceId}/send","href":"/api-reference/invoices/resend-an-invoice"},{"title":"List recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoice-series","href":"/api-reference/invoices/list-recurring-series"},{"title":"Create a recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoice-series","href":"/api-reference/invoices/create-a-recurring-series"},{"title":"Retrieve a recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/invoice-series/{seriesId}","href":"/api-reference/invoices/retrieve-a-recurring-series"},{"title":"Cancel a recurring series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/invoice-series/{seriesId}/cancel","href":"/api-reference/invoices/cancel-a-recurring-series"}]},{"group":"Checkout","pages":[{"title":"Create a checkout session","api":"POST https://pay.talescria.com/v1/sessions","href":"/api-reference/checkout/create-a-session"},{"title":"Retrieve a checkout session","api":"GET https://pay.talescria.com/v1/sessions/{id}","href":"/api-reference/checkout/retrieve-a-session"}]}]}]},"basePath":"","title":"Create a recipient - Talescria","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}