When consumer consumer_id was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (perks, slc) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Paylead","colors":{"primary":"#0465ff","light":"#4d7cff","dark":"#0146b8"},"logo":{"light":"https://mintcdn.com/paylead-04d0cbf1/5Du5nX6Yx2FNkQMU/logo/paylead-light.svg?fit=max\u0026auto=format\u0026n=5Du5nX6Yx2FNkQMU\u0026q=85\u0026s=ccd3972668e08f641390b653caf833dc","dark":"https://mintcdn.com/paylead-04d0cbf1/5Du5nX6Yx2FNkQMU/logo/paylead-dark.svg?fit=max\u0026auto=format\u0026n=5Du5nX6Yx2FNkQMU\u0026q=85\u0026s=289a65fff3ce15c8cbc8e9f292d1fdfa","href":"https://paylead.fr"},"favicon":"https://mintcdn.com/paylead-04d0cbf1/PhlJSwO-Cg3kzZM3/logo/favicon.png?fit=max\u0026auto=format\u0026n=PhlJSwO-Cg3kzZM3\u0026q=85\u0026s=82b4008639f970a617d69aff89f89eb3","api":{"playground":{"proxy":true},"examples":{"prefill":true}},"appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"light":"#ffffff","dark":"#1c212f"}},"navbar":{"primary":{"type":"button","label":"Request a demo","href":"https://paylead.fr"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/paylead","website":"https://paylead.fr"}},"seo":{"metatags":{"canonical":"https://docs.paylead.fr"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["download-pdf","download-spec"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paylead-04d0cbf1","hasAudioNarration":false,"actualSubdomain":"paylead-04d0cbf1","customDomains":["docs.paylead.fr"],"gitSource":{"type":"gitlab","owner":"paylead/projects","repo":"documentation","projectId":82335499,"deployBranch":"main","contentDirectory":"src","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea1921871e223557ceb059","collectionId":"dcf211c3-a453-4f92-abe3-73c3b91f2ed3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea1921871e223557ceb059"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea1921871e223557ceb059","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Program","count":87},{"language":"default","tag":"API","count":33},{"language":"default","tag":"Perks","count":27},{"language":"default","tag":"Documentation","count":25},{"language":"default","tag":"Shift","count":21},{"language":"default","tag":"Consumers","count":18},{"language":"default","tag":"Integration","count":8},{"language":"default","tag":"WebApp","count":8},{"language":"default","tag":"Catalog","count":6},{"language":"default","tag":"Reference \u0026 help","count":6}],"searchSettings":{"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@paylead.fr"}},"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":"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":"byok-sep-25","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":"billing-updated-9-15","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}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"program/api/thub/consumers/get-a-consumer","slug":"/program/api/thub/consumers/get-a-consumer","pageMetadata":{"title":"Get a consumer","description":"When consumer `consumer_id` was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (`perks`, `slc`) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json get /consumers/{consumer_id}","href":"/program/api/thub/consumers/get-a-consumer","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"When consumer \", _jsx(_components.code, {\n children: \"consumer_id\"\n }), \" was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (\", _jsx(_components.code, {\n children: \"perks\"\n }), \", \", _jsx(_components.code, {\n children: \"slc\"\n }), \") and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.\"]\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":"Get a consumer","description":"When consumer `consumer_id` was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (`perks`, `slc`) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json get /consumers/{consumer_id}","href":"/program/api/thub/consumers/get-a-consumer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"When consumer `consumer_id` was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (`perks`, `slc`) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.","operationId":"consumers__consumer_id__get","parameters":["c92c078d-9512-4464-a745-1d791631b098","796b39ad-ca67-46bd-9265-0efb8d5789a9"],"responses":{"200":"375dd894-88b6-4894-9692-6f2aeb07f03b","400":"335f7705-df9d-484b-9611-e3b621cb2a35","401":"6a651ea8-db93-4382-9fa9-482ab3bec254","403":"6c34cb2b-d4b3-4e09-9569-22c73c27a020","404":"69561e5c-736c-4426-b31a-ce7e611410f0","500":"a407bd4f-32dc-4129-850f-0bd7fd253e6a"},"summary":"Get a consumer","tags":["Consumers"],"method":"get","type":"path","servers":["b410415e-c514-40fe-8364-9f61700d2805"],"security":["66d40b6e-7f29-4efe-a7c8-cda0d9b9fa46"],"path":"/consumers/{consumer_id}","baseUrlOptions":["https://api-{programRef}.sandbox.paylead.tech"],"title":"Get a consumer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"c92c078d-9512-4464-a745-1d791631b098":{"description":"Unique ID of the consumer that you have registered when the user was onboarded.","in":"path","name":"consumer_id","required":true,"schema":{"description":"Unique ID of the consumer that you have registered when the user was onboarded.","maxLength":100,"minLength":2,"title":"Consumer Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"796b39ad-ca67-46bd-9265-0efb8d5789a9":{"examples":{"default":{"value":"2.0.0"}},"in":"header","name":"x-api-version","required":true,"schema":{"default":"2.0.0","title":"X-Api-Version","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"375dd894-88b6-4894-9692-6f2aeb07f03b":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier for a consumer on your system, alphanumeric string with optional dashes or underscores","example":"consumer-12345","examples":["consumer-12345"],"pattern":"^[a-zA-Z0-9_-]+$","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"onboarding_at":{"description":"When the consumer was onboarded on the Paylead platform.","format":"date-time","title":"Onboarding At","type":"string","isRequired":true,"uniqueKey":"onboarding_at","typeLabel":"string\u003cdate-time>"},"perks":{"oneOf":[{"type":"object","title":"PerksEnrollmentOut","required":["onboarding_at","consent_accepted_at"],"properties":{"consent_accepted_at":{"oneOf":[{"type":"string","title":"Consent Accepted At","description":"When the consumer accepted the program's terms in perks, null if never accepted.","format":"date-time","isRequired":true,"uniqueKey":"perks.oneOf.0.consent_accepted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Consent Accepted At","description":"When the consumer accepted the program's terms in perks, null if never accepted.","isRequired":true,"uniqueKey":"perks.oneOf.0.consent_accepted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"perks.oneOf.0.consent_accepted_at","typeLabel":"string\u003cdate-time> | null"},"onboarding_at":{"description":"When the consumer was onboarded in perks.","format":"date-time","title":"Onboarding At","type":"string","isRequired":true,"uniqueKey":"perks.oneOf.0.onboarding_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"perks.oneOf.0","typeLabel":"PerksEnrollmentOut · object"},{"type":"null","uniqueKey":"perks.oneOf.1","typeLabel":"null"}],"uniqueKey":"perks","typeLabel":"PerksEnrollmentOut · object | null"},"slc":{"oneOf":[{"type":"object","title":"SlcEnrollmentOut","required":["onboarding_at"],"properties":{"onboarding_at":{"description":"When the consumer was onboarded in SLC.","format":"date-time","title":"Onboarding At","type":"string","isRequired":true,"uniqueKey":"slc.oneOf.0.onboarding_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"slc.oneOf.0","typeLabel":"SlcEnrollmentOut · object"},{"type":"null","uniqueKey":"slc.oneOf.1","typeLabel":"null"}],"uniqueKey":"slc","typeLabel":"SlcEnrollmentOut · object | null"}},"required":["id","onboarding_at"],"title":"ConsumerDetailOutSchema","type":"object","uniqueKey":"","typeLabel":"ConsumerDetailOutSchema · object"},"examples":{"Example":{"title":"Example","value":{"id":"consumer-12345","onboarding_at":"2023-11-07T05:31:56Z","perks":{"consent_accepted_at":"2023-11-07T05:31:56Z","onboarding_at":"2023-11-07T05:31:56Z"},"slc":{"onboarding_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"335f7705-df9d-484b-9611-e3b621cb2a35":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"An error response object (PayLead profile).\n\nExtension members (e.g. ``errors`` for validation) are allowed and serialised as\ntop-level keys.","properties":{"code":{"description":"Error code describing the issue","example":"PL-4XX-YY","title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"description":"HTTP code returned by the API","example":400,"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"description":"Description of the issue","example":"The request was invalid.","title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["code","title","status"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"PL-4XX-YY","status":400,"title":"The request was invalid.","errors":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"instance":"api/resource/424242"}}},"exampleType":"generated"}},"description":"Bad Request","exampleType":"generated"},"6a651ea8-db93-4382-9fa9-482ab3bec254":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"An error response object (PayLead profile).\n\nExtension members (e.g. ``errors`` for validation) are allowed and serialised as\ntop-level keys.","properties":{"code":{"description":"Error code describing the issue","example":"PL-4XX-YY","title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"description":"HTTP code returned by the API","example":400,"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"description":"Description of the issue","example":"The request was invalid.","title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["code","title","status"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"PL-4XX-YY","status":400,"title":"The request was invalid.","errors":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"instance":"api/resource/424242"}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"6c34cb2b-d4b3-4e09-9569-22c73c27a020":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"An error response object (PayLead profile).\n\nExtension members (e.g. ``errors`` for validation) are allowed and serialised as\ntop-level keys.","properties":{"code":{"description":"Error code describing the issue","example":"PL-4XX-YY","title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"description":"HTTP code returned by the API","example":400,"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"description":"Description of the issue","example":"The request was invalid.","title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["code","title","status"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"PL-4XX-YY","status":400,"title":"The request was invalid.","errors":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"instance":"api/resource/424242"}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"69561e5c-736c-4426-b31a-ce7e611410f0":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"An error response object (PayLead profile).\n\nExtension members (e.g. ``errors`` for validation) are allowed and serialised as\ntop-level keys.","properties":{"code":{"description":"Error code describing the issue","example":"PL-4XX-YY","title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"description":"HTTP code returned by the API","example":400,"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"description":"Description of the issue","example":"The request was invalid.","title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["code","title","status"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"PL-4XX-YY","status":400,"title":"The request was invalid.","errors":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"instance":"api/resource/424242"}}},"exampleType":"generated"}},"description":"Not Found","exampleType":"generated"},"a407bd4f-32dc-4129-850f-0bd7fd253e6a":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"An error response object (PayLead profile).\n\nExtension members (e.g. ``errors`` for validation) are allowed and serialised as\ntop-level keys.","properties":{"code":{"description":"Error code describing the issue","example":"PL-4XX-YY","title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"description":"HTTP code returned by the API","example":400,"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"description":"Description of the issue","example":"The request was invalid.","title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"A list of individual error occurrences found","example":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference to the problematic resource","example":"api/resource/424242","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["code","title","status"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"PL-4XX-YY","status":400,"title":"The request was invalid.","errors":[{"loc":["body","field"],"msg":"Field required","type":"missing"}],"instance":"api/resource/424242"}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"}},"security":{"66d40b6e-7f29-4efe-a7c8-cda0d9b9fa46":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"ALL":"Full access to all resources (wildcard).","LOYALTIES":"Access to loyalties features.","PERKS":"Access to perks features.","TX_INJECTION":"Access to transaction sharing."},"tokenUrl":"/tokens"}},"type":"oauth2","scopes":[],"schemeName":"oauth2"}}},"servers":{"b410415e-c514-40fe-8364-9f61700d2805":{"description":"Sandbox","url":"https://api-{programRef}.sandbox.paylead.tech","variables":{"programRef":{"default":"changeme","description":"Program reference provided by Paylead"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"flows":{"clientCredentials":{"scopes":{"ALL":"Full access to all resources (wildcard).","LOYALTIES":"Access to loyalties features.","PERKS":"Access to perks features.","TX_INJECTION":"Access to transaction sharing."},"tokenUrl":"/tokens"}},"type":"oauth2","scopes":[],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"program/api/openapi/2.0.0/thub/openapi.json"},"subdomain":"paylead-04d0cbf1","siteName":"Paylead","title":"Get a consumer - Paylead","relatedPagesConfig":{"enabled":false,"limit":5,"mode":"automatic"},"contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T17:26:24.813Z","originalFileLocation":"program/api/thub/consumers/get-a-consumer.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=\"When consumer consumer_id was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (perks, slc) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paylead\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a consumer - Paylead\">\u003cmeta data-mint-head property=\"og:description\" content=\"When consumer consumer_id was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (perks, slc) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paylead\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paylead-04d0cbf1.mintlify.app/_mintlify/api/og/v2?division=Consumers\u0026amp;title=Get+a+consumer\u0026amp;description=When+consumer+%60consumer_id%60+was+onboarded+on+the+Paylead+platform+and+in+each+of+its+services%2C+queried+concurrently.+Each+service+contributes+its+own+field+%28%60pe\u0026amp;theme=0ae4be93b0c76567c32b5b8a\u0026amp;signature=d74d2d41ad3a512461a573dcf42306732abd464c0441ce50daf284dbb86a6951\">\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 consumer - Paylead\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"When consumer consumer_id was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (perks, slc) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paylead-04d0cbf1.mintlify.app/_mintlify/api/og/v2?division=Consumers\u0026amp;title=Get+a+consumer\u0026amp;description=When+consumer+%60consumer_id%60+was+onboarded+on+the+Paylead+platform+and+in+each+of+its+services%2C+queried+concurrently.+Each+service+contributes+its+own+field+%28%60pe\u0026amp;theme=0ae4be93b0c76567c32b5b8a\u0026amp;signature=d74d2d41ad3a512461a573dcf42306732abd464c0441ce50daf284dbb86a6951\">\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/paylead-04d0cbf1/v0TUrpbLtkswdNdJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paylead\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0465ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/program/api/thub/consumers/get-a-consumer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paylead.fr/#organization\",\"name\":\"Paylead\",\"url\":\"https://docs.paylead.fr\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paylead-04d0cbf1/5Du5nX6Yx2FNkQMU/logo/paylead-light.svg?fit=max\u0026auto=format\u0026n=5Du5nX6Yx2FNkQMU\u0026q=85\u0026s=ccd3972668e08f641390b653caf833dc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paylead.fr#website\",\"name\":\"Paylead\",\"url\":\"https://docs.paylead.fr\",\"publisher\":{\"@id\":\"https://docs.paylead.fr/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer#webpage\",\"url\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer\",\"name\":\"Get a consumer\",\"description\":\"When consumer consumer_id was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (perks, slc) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.\",\"dateModified\":\"2026-11-03T17:26:24.813Z\",\"isPartOf\":{\"@id\":\"https://docs.paylead.fr#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Consumers\",\"item\":\"https://docs.paylead.fr/program/api/thub/consumers/onboard-a-consumer-on-paylead-platform\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consumers\",\"item\":\"https://docs.paylead.fr/program/api/thub/consumers/onboard-a-consumer-on-paylead-platform\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a consumer\",\"item\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer#apireference\",\"headline\":\"Get a consumer\",\"name\":\"Get a consumer\",\"description\":\"When consumer consumer_id was onboarded on the Paylead platform and in each of its services, queried concurrently. Each service contributes its own field (perks, slc) and is only included when it responds: a service that fails, times out or does not know the consumer is omitted from the payload.\",\"url\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paylead.fr/program/api/thub/consumers/get-a-consumer#webpage\"},\"dateModified\":\"2026-11-03T17:26:24.813Z\",\"publisher\":{\"@id\":\"https://docs.paylead.fr/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paylead.fr#website\"}}]}\u003c/script>","siteName":"Paylead","nav":{"global":null,"products":[{"product":"Program","icon":"landmark","description":"Documentation for Paylead bank partners","tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":"/program/user-journey/what-is-paylead"}]},{"tab":"API","icon":"code","groups":[{"group":"Overview","icon":"compass","pages":[{"title":"API conventions","href":"/program/api/overview"}]},{"group":"Authentication","icon":"key","pages":[{"group":"Tokens","pages":[{"title":"Issue an access token","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/authz/openapi.json post /tokens","href":"/program/api/authz/tokens/issue-an-access-token"}]}]},{"group":"Consumers","icon":"users","pages":[{"group":"Consumers","pages":[{"title":"Onboard a consumer on Paylead platform","description":"Create a consumer by providing it's `consumer_id`","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json post /consumers","href":"/program/api/thub/consumers/onboard-a-consumer-on-paylead-platform"},{"title":"Get a consumer","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json get /consumers/{consumer_id}","href":"/program/api/thub/consumers/get-a-consumer"},{"title":"Offboard a consumer from Paylead platform","description":"Delete a consumer by providing it's `consumer_id`","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json delete /consumers/{consumer_id}","href":"/program/api/thub/consumers/offboard-a-consumer-from-paylead-platform"}]},{"group":"Rewards","pages":[{"title":"Get a consumer's aggregated reward information","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json get /consumers/{consumer_id}/rewards/info","href":"/program/api/thub/rewards/get-a-consumers-aggregated-reward-information"}]},{"group":"Bulk Transaction","pages":[{"title":"Create a bulk of transactions","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json post /consumers/{consumer_id}/transactions","href":"/program/api/thub/bulk-transaction/create-a-bulk-of-transactions"},{"title":"Create a bulk of historical transactions","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json post /consumers/{consumer_id}/transactions/history","href":"/program/api/thub/bulk-transaction/create-a-bulk-of-historical-transactions"}]},{"group":"Transaction","pages":[{"title":"Update transaction","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json put /consumers/{consumer_id}/transactions/{transaction_id}","href":"/program/api/thub/transaction/update-transaction"},{"title":"Delete transaction","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/thub/openapi.json delete /consumers/{consumer_id}/transactions/{transaction_id}","href":"/program/api/thub/transaction/delete-transaction"}]}]},{"group":"Perks","icon":"wallet","pages":[{"group":"Brands","pages":[{"title":"List brands with active offers in the program's catalog.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/brands","href":"/program/api/perks/brands/list-brands-with-active-offers-in-the-programs-catalog"},{"title":"List brands with offers visible to this consumer in the program's catalog.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/brands","href":"/program/api/perks/brands/list-brands-with-offers-visible-to-this-consumer-in-the-programs-catalog"},{"title":"Get detail for a brand in this program's catalog.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/brands/{brand_id}","href":"/program/api/perks/brands/get-detail-for-a-brand-in-this-programs-catalog"}]},{"group":"Consumers","pages":[{"title":"Enroll a consumer into the perks program (accept CGU).","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json post /perks/consumers","href":"/program/api/perks/consumers/enroll-a-consumer-into-the-perks-program-accept-cgu"},{"title":"Send a consumer's reconciliation data (hashed email).","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json post /perks/consumers/{consumer_id}/reconciliation","href":"/program/api/perks/consumers/send-a-consumers-reconciliation-data-hashed-email"},{"title":"Delete a consumer's reconciliation data.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json delete /perks/consumers/{consumer_id}/reconciliation/{reconciliation_key}","href":"/program/api/perks/consumers/delete-a-consumers-reconciliation-data"}]},{"group":"UPM","pages":[{"title":"Read the payment account currently designated for a consumer.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/accounts/payment","href":"/program/api/perks/upm/read-the-payment-account-currently-designated-for-a-consumer"},{"title":"Designate the bank account where a consumer wants to be paid out.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json post /perks/consumers/{consumer_id}/accounts/payment","href":"/program/api/perks/upm/designate-the-bank-account-where-a-consumer-wants-to-be-paid-out"},{"title":"Revoke the consumer's currently designated payment account.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json delete /perks/consumers/{consumer_id}/accounts/payment","href":"/program/api/perks/upm/revoke-the-consumers-currently-designated-payment-account"},{"title":"Trigger a payout of the consumer's pool.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json post /perks/consumers/{consumer_id}/pools/me/payouts","href":"/program/api/perks/upm/trigger-a-payout-of-the-consumers-pool"}]},{"group":"KYC","pages":[{"title":"Create or update a consumer's KYC (Mangopay natural user).","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json put /perks/consumers/{consumer_id}/kyc","href":"/program/api/perks/kyc/create-or-update-a-consumers-kyc-mangopay-natural-user"}]},{"group":"Offers","pages":[{"title":"List offers visible to this consumer in the program's catalog.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/offers","href":"/program/api/perks/offers/list-offers-visible-to-this-consumer-in-the-programs-catalog"},{"title":"Get detail for an offer visible to this consumer in the program's catalog.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/offers/{offer_id}","href":"/program/api/perks/offers/get-detail-for-an-offer-visible-to-this-consumer-in-the-programs-catalog"}]},{"group":"Rewards","pages":[{"title":"List the rewards a consumer has received.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/rewards","href":"/program/api/perks/rewards/list-the-rewards-a-consumer-has-received"},{"title":"List the payments that paid a consumer's rewards out to their bank account.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/rewards/payments","href":"/program/api/perks/rewards/list-the-payments-that-paid-a-consumers-rewards-out-to-their-bank-account"},{"title":"Get one of the rewards a consumer has received.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/rewards/{reward_id}","href":"/program/api/perks/rewards/get-one-of-the-rewards-a-consumer-has-received"}]},{"group":"Segments","pages":[{"title":"List the segments a consumer is currently assigned to.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/segments","href":"/program/api/perks/segments/list-the-segments-a-consumer-is-currently-assigned-to"},{"title":"Assign a consumer to a segment.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json post /perks/consumers/{consumer_id}/segments/{segment_reference}","href":"/program/api/perks/segments/assign-a-consumer-to-a-segment"},{"title":"Unassign a consumer from a segment.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json delete /perks/consumers/{consumer_id}/segments/{segment_reference}","href":"/program/api/perks/segments/unassign-a-consumer-from-a-segment"}]},{"group":"Universes","pages":[{"title":"List the catalog's top-level universes.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/universes","href":"/program/api/perks/universes/list-the-catalogs-top-level-universes"}]},{"group":"Voucher Orders","pages":[{"title":"List the READY voucher orders a consumer has placed.","deprecated":null,"version":null,"openapi":"/program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/voucher-orders","href":"/program/api/perks/voucher-orders/list-the-ready-voucher-orders-a-consumer-has-placed"}]}]},{"group":"Resources","icon":"files","pages":[{"title":"Integration guidelines","href":"/program/api/integration-guidelines"},{"title":"Versions \u0026 Download","href":"/program/api/releases"}]}]},{"tab":"Connector v1.1.12","hidden":true,"pages":[{"title":"Connector v1.1.12","href":"/program/api/legacy/1.1.12/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.11","hidden":true,"pages":[{"title":"Connector v1.1.11","href":"/program/api/legacy/1.1.11/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.10","hidden":true,"pages":[{"title":"Connector v1.1.10","href":"/program/api/legacy/1.1.10/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.9","hidden":true,"pages":[{"title":"Connector v1.1.9","href":"/program/api/legacy/1.1.9/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.8","hidden":true,"pages":[{"title":"Connector v1.1.8","href":"/program/api/legacy/1.1.8/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.7","hidden":true,"pages":[{"title":"Connector v1.1.7","href":"/program/api/legacy/1.1.7/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.6","hidden":true,"pages":[{"title":"Connector v1.1.6","href":"/program/api/legacy/1.1.6/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.5","hidden":true,"pages":[{"title":"Connector v1.1.5","href":"/program/api/legacy/1.1.5/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.4","hidden":true,"pages":[{"title":"Connector v1.1.4","href":"/program/api/legacy/1.1.4/connector/banks/gets-the-list-of-banks"}]},{"tab":"M2M v1.1.4","hidden":true,"pages":[{"title":"M2M v1.1.4","href":"/program/api/legacy/1.1.4/m2m/lbs/get-the-lbs-strategies"}]},{"tab":"Connector v1.1.3","hidden":true,"pages":[{"title":"Connector v1.1.3","href":"/program/api/legacy/1.1.3/connector/banks/gets-the-list-of-banks"}]},{"tab":"M2M v1.1.3","hidden":true,"pages":[{"title":"M2M v1.1.3","href":"/program/api/legacy/1.1.3/m2m/lbs/get-the-lbs-strategies"}]},{"tab":"Connector v1.1.2","hidden":true,"pages":[{"title":"Connector v1.1.2","href":"/program/api/legacy/1.1.2/connector/banks/gets-the-list-of-banks"}]},{"tab":"Injector v1.1.2","hidden":true,"pages":[{"title":"Injector v1.1.2","href":"/program/api/legacy/1.1.2/injector/health/health-check"}]},{"tab":"M2M v1.1.2","hidden":true,"pages":[{"title":"M2M v1.1.2","href":"/program/api/legacy/1.1.2/m2m/lbs/get-the-lbs-strategies"}]},{"tab":"Connector v1.1.1","hidden":true,"pages":[{"title":"Connector v1.1.1","href":"/program/api/legacy/1.1.1/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.1.0","hidden":true,"pages":[{"title":"Connector v1.1.0","href":"/program/api/legacy/1.1.0/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.0.1","hidden":true,"pages":[{"title":"Connector v1.0.1","href":"/program/api/legacy/1.0.1/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v1.0.0","hidden":true,"pages":[{"title":"Connector v1.0.0","href":"/program/api/legacy/1.0.0/connector/banks/gets-the-list-of-banks"}]},{"tab":"Connector v0.3.0","hidden":true,"pages":[{"title":"Connector v0.3.0","href":"/program/api/legacy/0.3.0/connector/banks/gets-the-list-of-banks"}]},{"tab":"WebApp","icon":"smartphone","pages":[{"title":"WebApp","href":"/program/webapp/overview"}]},{"tab":"Link","icon":"network","hidden":true,"pages":[{"title":"Link","href":"/program/link/overview"}]},{"tab":"Shift","icon":"shuffle","pages":[{"title":"Shift","href":"/program/shift/overview"}]},{"tab":"LBS","icon":"store","hidden":true,"pages":[{"title":"LBS","href":"/program/lbs/overview"}]},{"tab":"Reference","icon":"eye-off","hidden":true,"pages":[{"title":"Reference","href":"/program/user-journey/concepts/autonomous-ventilation"}]},{"tab":"Glossary","icon":"book-open-text","pages":[{"title":"Glossary","href":"/glossary"}]}]},{"product":"Retailers","icon":"store","description":"Documentation for Paylead merchant partners","pages":[{"title":"Retailers","href":"/retailers/guides/sales-report-automation"}]}]},"basePath":"","title":"Get a consumer - Paylead","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}