Titularidade da conta de destino. SELF_OWNED: o beneficiário é a mesma pessoa que o remetente (conta própria no Brasil). THIRD_PARTY: o beneficiário é outra pessoa ou empresa. No withdrawal, SELF_OWNED exige senderRelationship = SELF e THIRD_PARTY não aceita SELF.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Javali Bridge","colors":{"primary":"#01758e","light":"#2fc7b4","dark":"#01758e"},"logo":{"light":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/logo_claro_horizontal.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=3ece6de2f0f2cbc827ab24f49af178ac","dark":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/logo_escuro_horizontal.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=cfbaee09fe23884f338241c45b3037d0"},"favicon":{"light":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/simbolo_claro.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=a4d3e3db13949d32b56bae7553739a7e","dark":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/simbolo_escuro.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=28fb8cbea6d515f1a33050b314afee28"},"api":{"openapi":"api-reference/openapi.yaml","playground":{"display":"simple"}},"fonts":{"family":"Plus Jakarta Sans"},"icons":{"library":"lucide"},"styling":{"latex":false},"contextual":{"options":["copy","view","claude","chatgpt","grok","cursor","mcp"],"display":"header"},"navigation":{"languages":[{"language":"en","default":true,"href":"en/guides/overview"},{"language":"pt-BR","href":"pt-BR/guides/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"javali-gateway","hasAudioNarration":false,"actualSubdomain":"javali-gateway","customDomains":["developers.javalibridge.com"],"gitSource":{"type":"github","owner":"javali-holding","repo":"bridge","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae4d6eec08b8c12f5dc0c02"},"chroma":{"latestBuiltDeploymentHistoryId":"6aeb901cb8fd7618a50e168c","collectionId":"922b83e8-c537-4eea-9745-f7ee60e4cbb3","liveDeploymentHistoryId":"6aeb901cb8fd7618a50e168c","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeb901cb8fd7618a50e168c","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"en","tag":"API reference","count":33},{"language":"pt-BR","tag":"Referência da API","count":33},{"language":"en","tag":"Guides","count":20},{"language":"pt-BR","tag":"Guias","count":20},{"language":"en","tag":"Remittances","count":11},{"language":"pt-BR","tag":"Remessas","count":11},{"language":"en","tag":"Webhooks","count":5},{"language":"en","tag":"Get started","count":5},{"language":"pt-BR","tag":"Webhooks","count":5},{"language":"pt-BR","tag":"Primeiros passos","count":5},{"language":"en","tag":"Beneficiaries","count":4},{"language":"en","tag":"Senders","count":4},{"language":"en","tag":"Records and balances","count":4},{"language":"en","tag":"Operations","count":4},{"language":"pt-BR","tag":"Beneficiários","count":4},{"language":"pt-BR","tag":"Remetentes","count":4},{"language":"pt-BR","tag":"Cadastros e saldos","count":4},{"language":"pt-BR","tag":"Operação","count":4},{"language":"en","tag":"Inventories","count":3},{"language":"pt-BR","tag":"Inventories","count":3}]},"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":"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":"llms-txt-v2","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":"vite-origin","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":"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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"en/api-reference/get-beneficiary","slug":"/en/api-reference/get-beneficiary","pageMetadata":{"title":"Get a beneficiary","openapi":"api-reference/openapi.yaml GET /v1/beneficiaries/{beneficiaryId}","description":null,"href":"/en/api-reference/get-beneficiary"},"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":"Get a beneficiary","openapi":"api-reference/openapi.yaml GET /v1/beneficiaries/{beneficiaryId}","description":null,"href":"/en/api-reference/get-beneficiary"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Beneficiaries"],"operationId":"getBeneficiary","summary":"Consultar beneficiário com instruções e status de triagem","responses":{"200":"88ae6839-398f-40b1-9808-f74ad46415ee","404":"4fdf09c8-ad11-49f7-9d1c-1db3510fba13","429":"917f48b5-75e5-4d45-814d-f0d5ce2b1377"},"method":"get","type":"path","servers":["e1c7cca6-0a6d-45dc-af55-117cd631be06","4f5ef475-2ad4-43b9-ac16-0194e67712b8"],"security":["447b5079-5f74-4819-b781-78fe3aa17175"],"path":"/v1/beneficiaries/{beneficiaryId}","baseUrlOptions":["https://api.lbpay.example.com","https://sandbox.lbpay.example.com"],"title":"Consultar beneficiário com instruções e status de triagem","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"840d08fc-2ed2-411f-b03e-986c25d41ae0":{"name":"beneficiaryId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"88ae6839-398f-40b1-9808-f74ad46415ee":{"description":"Beneficiary","content":{"application/json":{"schema":{"type":"object","required":["beneficiaryId","status","relationshipType","entity"],"properties":{"relationshipType":{"type":"string","enum":["SELF_OWNED","THIRD_PARTY"],"description":"Titularidade da conta de destino. SELF_OWNED: o beneficiário é a mesma pessoa que o remetente (conta própria no Brasil). THIRD_PARTY: o beneficiário é outra pessoa ou empresa. No withdrawal, SELF_OWNED exige senderRelationship = SELF e THIRD_PARTY não aceita SELF.","isRequired":true,"uniqueKey":"relationshipType","typeLabel":"enum\u003cstring>"},"entity":{"type":"object","required":["type","identificationDocument","address"],"properties":{"type":{"type":"string","enum":["INDIVIDUAL","BUSINESS"],"isRequired":true,"uniqueKey":"entity.type","typeLabel":"enum\u003cstring>"},"identificationDocument":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Country-specific document type, e.g. CPF, CNPJ, PASSPORT.","isRequired":true,"uniqueKey":"entity.identificationDocument.type","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"entity.identificationDocument.value","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","uniqueKey":"entity.identificationDocument.countryCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"entity.identificationDocument","typeLabel":"object"},"address":{"type":"object","required":["line1","city","state","postalCode","country"],"description":"Endereço do beneficiário, usado na triagem.","properties":{"line1":{"type":"string","maxLength":200,"example":"Rua das Flores 250","isRequired":true,"uniqueKey":"entity.address.line1","typeLabel":"string"},"city":{"type":"string","maxLength":100,"example":"Belo Horizonte","isRequired":true,"uniqueKey":"entity.address.city","typeLabel":"string"},"state":{"type":"string","pattern":"^[A-Z]{2}$","description":"UF com 2 letras.","example":"MG","isRequired":true,"uniqueKey":"entity.address.state","typeLabel":"string"},"postalCode":{"type":"string","pattern":"^[0-9]{5}-?[0-9]{3}$","description":"CEP.","example":"30130-110","isRequired":true,"uniqueKey":"entity.address.postalCode","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 3166-1 alfa-3.","example":"BRA","isRequired":true,"uniqueKey":"entity.address.country","typeLabel":"string"},"line2":{"type":"string","maxLength":100,"description":"Complemento (opcional).","example":"Apto 101","uniqueKey":"entity.address.line2","typeLabel":"string"}},"example":{"line1":"Rua das Flores 250","city":"Belo Horizonte","state":"MG","postalCode":"30130-110","country":"BRA"},"isRequired":true,"uniqueKey":"entity.address","typeLabel":"object"},"firstName":{"type":"string","maxLength":150,"uniqueKey":"entity.firstName","typeLabel":"string"},"lastName":{"type":"string","maxLength":150,"uniqueKey":"entity.lastName","typeLabel":"string"},"businessName":{"type":"string","maxLength":200,"uniqueKey":"entity.businessName","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"entity.email","typeLabel":"string\u003cemail>"},"birthDate":{"type":"string","format":"date","uniqueKey":"entity.birthDate","typeLabel":"string\u003cdate>"}},"description":"INDIVIDUAL exige firstName e lastName; BUSINESS exige businessName. Endereço obrigatório para a triagem.","isRequired":true,"uniqueKey":"entity","typeLabel":"object"},"beneficiaryId":{"type":"string","isRequired":true,"uniqueKey":"beneficiaryId","typeLabel":"string"},"status":{"type":"string","enum":["ACTIVE","BLOCKED","INACTIVE"],"description":"Situação do cadastro. Pode receber se ACTIVE e com ao menos uma instrução APPROVED.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"paymentInstructions":{"type":"array","items":{"type":"object","required":["paymentInstructionId","status","rail","asset"],"properties":{"rail":{"type":"string","description":"Payout rail, e.g. PIX_KEY or LOCAL_BANK_TRANSFER.","isRequired":true,"uniqueKey":"paymentInstructions.items.[INDEX].rail","typeLabel":"string"},"asset":{"type":"string","pattern":"^[A-Z]{3}$","isRequired":true,"uniqueKey":"paymentInstructions.items.[INDEX].asset","typeLabel":"string"},"paymentInstructionId":{"type":"string","isRequired":true,"uniqueKey":"paymentInstructions.items.[INDEX].paymentInstructionId","typeLabel":"string"},"status":{"type":"string","enum":["SCREENING","APPROVED","REJECTED","INACTIVE"],"description":"Triagem automática na criação: identidade do beneficiário contra listas de sanções e PEP, e existência da chave Pix no diretório. A primeira instrução de um beneficiário passa pela triagem completa; as seguintes, por verificação reduzida da nova chave. Só APPROVED recebe. Motivos de reprovação não são detalhados.","isRequired":true,"uniqueKey":"paymentInstructions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"dictKeyType":{"type":"string","enum":["CPF","CNPJ","EMAIL","PHONE","EVP"],"uniqueKey":"paymentInstructions.items.[INDEX].dictKeyType","typeLabel":"enum\u003cstring>"},"dictKey":{"type":"string","maxLength":200,"uniqueKey":"paymentInstructions.items.[INDEX].dictKey","typeLabel":"string"},"bankAccount":{"type":"object","description":"Rail-specific bank account details where applicable","additionalProperties":true,"uniqueKey":"paymentInstructions.items.[INDEX].bankAccount","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"paymentInstructions.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"screenedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"paymentInstructions.items.[INDEX].screenedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"paymentInstructions.items.[INDEX].screenedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInstructions.items.[INDEX].screenedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"paymentInstructions.items.[INDEX]","typeLabel":"object"},"description":"Ao menos uma instrução APPROVED é necessária para criar um withdrawal para este beneficiário.","uniqueKey":"paymentInstructions","typeLabel":"object[]"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"relationshipType":"SELF_OWNED","entity":{"type":"INDIVIDUAL","identificationDocument":{"type":"\u003cstring>","value":"\u003cstring>","countryCode":"\u003cstring>"},"address":{"line1":"Rua das Flores 250","city":"Belo Horizonte","state":"MG","postalCode":"30130-110","country":"BRA"},"firstName":"\u003cstring>","lastName":"\u003cstring>","businessName":"\u003cstring>","email":"jsmith@example.com","birthDate":"2023-12-25"},"beneficiaryId":"\u003cstring>","status":"ACTIVE","paymentInstructions":[{"rail":"\u003cstring>","asset":"\u003cstring>","paymentInstructionId":"\u003cstring>","status":"SCREENING","dictKeyType":"CPF","dictKey":"\u003cstring>","bankAccount":{},"createdAt":"2023-11-07T05:31:56Z","screenedAt":"2023-11-07T05:31:56Z"}],"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"4fdf09c8-ad11-49f7-9d1c-1db3510fba13":{"description":"Recurso não encontrado no tenant autenticado","content":{"application/json":{"schema":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Código do catálogo `x-error-catalog`. Extensível: trate códigos desconhecidos pelo HTTP status.","example":"QUOTE_EXPIRED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"retryable":{"type":"boolean","description":"Indica se a mesma requisição pode ser repetida (com a mesma Idempotency-Key).","uniqueKey":"retryable","typeLabel":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"details.items.[INDEX].field","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"details.items.[INDEX].reason","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"QUOTE_EXPIRED","message":"\u003cstring>","requestId":"\u003cstring>","retryable":true,"details":[{"field":"\u003cstring>","reason":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"917f48b5-75e5-4d45-814d-f0d5ce2b1377":{"description":"Limite de requisições excedido (RATE_LIMITED)","headers":{"Retry-After":{"description":"Segundos até nova tentativa","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Código do catálogo `x-error-catalog`. Extensível: trate códigos desconhecidos pelo HTTP status.","example":"QUOTE_EXPIRED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"retryable":{"type":"boolean","description":"Indica se a mesma requisição pode ser repetida (com a mesma Idempotency-Key).","uniqueKey":"retryable","typeLabel":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"details.items.[INDEX].field","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"details.items.[INDEX].reason","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"QUOTE_EXPIRED","message":"\u003cstring>","requestId":"\u003cstring>","retryable":true,"details":[{"field":"\u003cstring>","reason":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"447b5079-5f74-4819-b781-78fe3aa17175":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"e1c7cca6-0a6d-45dc-af55-117cd631be06":{"url":"https://api.lbpay.example.com","description":"Example production URL - replace before use"},"4f5ef475-2ad4-43b9-ac16-0194e67712b8":{"url":"https://sandbox.lbpay.example.com","description":"Example sandbox URL - replace before use"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"javali-gateway","siteName":"Javali Bridge","title":"Get a beneficiary - Javali Bridge","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/api-reference/get-beneficiary","matchLevel":0},"pt-BR":{"href":"/pt-BR/api-reference/get-beneficiary","matchLevel":1}}},"lastModified":"2026-11-04T20:05:54.009Z","originalFileLocation":"en/api-reference/get-beneficiary.mdx","locale":"en"},"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=\"application-name\" content=\"Javali Bridge\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_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/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_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/javali-gateway/Rjdr5ILyetQAYt56/_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/javali-gateway/Rjdr5ILyetQAYt56/_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/javali-gateway/Rjdr5ILyetQAYt56/_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/javali-gateway/Rjdr5ILyetQAYt56/_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/javali-gateway/Rjdr5ILyetQAYt56/_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/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a beneficiary - Javali Bridge\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Javali Bridge\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.javalibridge.com/en/api-reference/get-beneficiary\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://javali-gateway.mintlify.app/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Get+a+beneficiary\u0026amp;theme=c4bea45393e4cc5a4a7f2c03\u0026amp;signature=2f40286bf5a6d4b0d67e52c8188c44c417ddf2173168337e91fabde3a32fa18d\">\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=\"Get a beneficiary - Javali Bridge\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://javali-gateway.mintlify.app/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Get+a+beneficiary\u0026amp;theme=c4bea45393e4cc5a4a7f2c03\u0026amp;signature=2f40286bf5a6d4b0d67e52c8188c44c417ddf2173168337e91fabde3a32fa18d\">\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/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Javali Bridge\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#01758e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.javalibridge.com/en/api-reference/get-beneficiary\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/get-beneficiary.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developers.javalibridge.com/en/api-reference/get-beneficiary\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://developers.javalibridge.com/pt-BR/api-reference/get-beneficiary\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developers.javalibridge.com/en/api-reference/get-beneficiary\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.javalibridge.com/#organization\",\"name\":\"Javali Bridge\",\"url\":\"https://developers.javalibridge.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/logo_claro_horizontal.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=3ece6de2f0f2cbc827ab24f49af178ac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.javalibridge.com#website\",\"name\":\"Javali Bridge\",\"url\":\"https://developers.javalibridge.com\",\"publisher\":{\"@id\":\"https://developers.javalibridge.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary#webpage\",\"url\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary\",\"name\":\"Get a beneficiary\",\"dateModified\":\"2026-11-04T20:05:54.009Z\",\"isPartOf\":{\"@id\":\"https://developers.javalibridge.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Beneficiaries\",\"item\":\"https://developers.javalibridge.com/en/api-reference/create-beneficiary\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a beneficiary\",\"item\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary#apireference\",\"headline\":\"Get a beneficiary\",\"name\":\"Get a beneficiary\",\"url\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary\",\"mainEntityOfPage\":{\"@id\":\"https://developers.javalibridge.com/en/api-reference/get-beneficiary#webpage\"},\"dateModified\":\"2026-11-04T20:05:54.009Z\",\"publisher\":{\"@id\":\"https://developers.javalibridge.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.javalibridge.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Javali Bridge\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Javali Bridge","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en/guides/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API conventions","href":"/en/api-reference/conventions"}]},{"group":"Health","pages":[{"title":"Health check","openapi":"api-reference/openapi.yaml GET /v1/health","href":"/en/api-reference/get-health"}]},{"group":"FX Quotes","pages":[{"title":"Request a quote","openapi":"api-reference/openapi.yaml POST /v1/fx/quotes","href":"/en/api-reference/create-fx-quote"},{"title":"Get a quote","openapi":"api-reference/openapi.yaml GET /v1/fx/quotes/{quoteId}","href":"/en/api-reference/get-fx-quote"}]},{"group":"Inventories","pages":[{"title":"Create an inventory lot","openapi":"api-reference/openapi.yaml POST /v1/inventories","href":"/en/api-reference/create-inventory"},{"title":"List inventory lots","openapi":"api-reference/openapi.yaml GET /v1/inventories","href":"/en/api-reference/list-inventories"},{"title":"Get an inventory lot","openapi":"api-reference/openapi.yaml GET /v1/inventories/{inventoryId}","href":"/en/api-reference/get-inventory"}]},{"group":"Remittances","pages":[{"title":"Create a withdrawal","openapi":"api-reference/openapi.yaml POST /v1/remittances/withdrawals","href":"/en/api-reference/create-withdrawal"},{"title":"List remittances","openapi":"api-reference/openapi.yaml GET /v1/remittances","href":"/en/api-reference/list-remittances"},{"title":"Get a remittance","openapi":"api-reference/openapi.yaml GET /v1/remittances/{remittanceId}","href":"/en/api-reference/get-remittance"},{"title":"Get the Pix receipt","openapi":"api-reference/openapi.yaml GET /v1/remittances/{remittanceId}/receipt","href":"/en/api-reference/get-remittance-receipt"}]},{"group":"Senders","pages":[{"title":"Create a sender","openapi":"api-reference/openapi.yaml POST /v1/senders","href":"/en/api-reference/create-sender"},{"title":"List senders","openapi":"api-reference/openapi.yaml GET /v1/senders","href":"/en/api-reference/list-senders"},{"title":"Get a sender","openapi":"api-reference/openapi.yaml GET /v1/senders/{senderId}","href":"/en/api-reference/get-sender"},{"title":"Update a sender","openapi":"api-reference/openapi.yaml PATCH /v1/senders/{senderId}","href":"/en/api-reference/update-sender"}]},{"group":"Beneficiaries","pages":[{"title":"Create a beneficiary","openapi":"api-reference/openapi.yaml POST /v1/beneficiaries","href":"/en/api-reference/create-beneficiary"},{"title":"List beneficiaries","openapi":"api-reference/openapi.yaml GET /v1/beneficiaries","description":null,"href":"/en/api-reference/list-beneficiaries"},{"title":"Get a beneficiary","openapi":"api-reference/openapi.yaml GET /v1/beneficiaries/{beneficiaryId}","href":"/en/api-reference/get-beneficiary"},{"title":"Update a beneficiary","openapi":"api-reference/openapi.yaml PATCH /v1/beneficiaries/{beneficiaryId}","description":null,"href":"/en/api-reference/update-beneficiary"}]},{"group":"Credit line","pages":[{"title":"Get the credit line","openapi":"api-reference/openapi.yaml GET /v1/credit-line","href":"/en/api-reference/get-credit-line"}]},{"group":"Limits","pages":[{"title":"Get account limits","openapi":"api-reference/openapi.yaml GET /v1/limits","href":"/en/api-reference/get-account-limits"},{"title":"Get sender limits","openapi":"api-reference/openapi.yaml GET /v1/limits/senders/{senderId}","href":"/en/api-reference/get-sender-limits"},{"title":"Get beneficiary limits","openapi":"api-reference/openapi.yaml GET /v1/limits/beneficiaries/{beneficiaryId}","href":"/en/api-reference/get-beneficiary-limits"}]},{"group":"Wallets","pages":[{"title":"List wallets","openapi":"api-reference/openapi.yaml GET /v1/wallets","href":"/en/api-reference/list-wallets"},{"title":"List wallet transactions","openapi":"api-reference/openapi.yaml GET /v1/wallets/transactions","href":"/en/api-reference/list-wallet-transactions"}]},{"group":"Settlements","pages":[{"title":"List settlement batches","openapi":"api-reference/openapi.yaml GET /v1/settlements","href":"/en/api-reference/list-settlements"},{"title":"Get a settlement batch","openapi":"api-reference/openapi.yaml GET /v1/settlements/{settlementId}","href":"/en/api-reference/get-settlement"},{"title":"List batch items","openapi":"api-reference/openapi.yaml GET /v1/settlements/{settlementId}/items","href":"/en/api-reference/list-settlement-items"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","openapi":"api-reference/openapi.yaml GET /v1/webhooks","href":"/en/api-reference/list-webhooks"},{"title":"Register a webhook endpoint","openapi":"api-reference/openapi.yaml POST /v1/webhooks","href":"/en/api-reference/create-webhook"},{"title":"Delete a webhook endpoint","openapi":"api-reference/openapi.yaml DELETE /v1/webhooks/{webhookId}","href":"/en/api-reference/delete-webhook"},{"title":"List webhook deliveries","openapi":"api-reference/openapi.yaml GET /v1/webhooks/{webhookId}/deliveries","href":"/en/api-reference/list-webhook-deliveries"},{"title":"Retry a webhook delivery","openapi":"api-reference/openapi.yaml POST /v1/webhooks/{webhookId}/deliveries/{deliveryId}/retry","href":"/en/api-reference/retry-webhook-delivery"}]}]}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR/api-reference/get-beneficiary"}]}]},"basePath":"","title":"Get a beneficiary - Javali Bridge","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}