using RestSharp;
var options = new RestClientOptions("https://kyc.sbx.moduluslabs.io/v2/onboard/{refNo}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://kyc.sbx.moduluslabs.io/v2/onboard/{refNo}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
Retrieves the complete onboarding data for a merchant using the onboarding reference number. This endpoint returns all information submitted during the onboarding process, including business details, representatives, bank accounts, and current approval status.
Use case: Check the status of a merchant’s onboarding application and retrieve all submitted information for review or updates.
Authentication
This endpoint requires JWT Bearer Token authentication.
Authorization Required: The authenticated user must be the owner of the onboarding record. Only the user who created the onboarding record can retrieve it.
Onboarding Status Flow
1
NEW
Merchant has completed the onboarding form and submitted it for initial review. Awaiting admin approval.
2
DECLINED (Optional)
Admin reviewed the application and declined it. The declinedReason field contains the reason for rejection. Merchant needs to update their information.
3
PENDING (Optional)
Merchant has updated their form after being declined and resubmitted for review. Awaiting admin re-approval.
4
APPROVED
Admin has approved the merchant’s onboarding application. Merchant can now process transactions.
Bank Account Masking
Security Feature: Bank account numbers are masked for security based on user roles.
Full account numbers visible to:
The account that owns the record
The account owner (authenticated user who created the onboarding record)
Other users see:********1234 (only last 4 digits visible)
Use Cases
Check Application Status
Monitor the approval status of your onboarding application
Review Submitted Data
Verify all information submitted during onboarding
Handle Declined Applications
Check the decline reason and prepare updated information
Retrieve for Updates
Get current data before submitting corrections or updates
Troubleshooting
Reference Number Mismatch Error
Error:Onboarding reference number mismatchCause: You’re trying to access an onboarding record that doesn’t belong to your accountSolution:
Verify you’re using the correct JWT token for the account that created this onboarding record
Each onboarding record can only be accessed by the account that created it
Access is limited to records associated with your authenticated account.
Invalid UUID Format
Error:Invalid onboarding reference number formatSolution:
Ensure the reference number is a valid UUID v4 format
Example valid format: 550e8400-e29b-41d4-a716-446655440000
Check for extra spaces or incorrect characters
Record Not Found
Error:Onboarding record does not existPossible Causes:
The reference number is incorrect
The onboarding record was deleted
You’re using a sandbox reference number in production (or vice versa)
Solution:
Double-check the reference number
Verify you’re using the correct environment (sandbox vs production)
Next Steps
Onboard Merchant
Create a new merchant onboarding record
Create Account
Create an account before onboarding
Authentication Guide
Learn about JWT token authentication
Error Handling
Handle API errors properly
Authorizations
Authorization
string
header
required
JWT Bearer token authentication
Path Parameters
refNo
string<uuid>
required
The onboarding reference number (UUID v4 format)
Response
Onboarding data retrieved successfully
onboardingStatus
enum<string>
Available options:
NEW,
PENDING,
APPROVED,
DECLINED
onboardingReferenceNumber
string<uuid>
merchantName
string
legalName
string
businessHandle
string
modeOfPayments
string[]
currency
string
tin
string
industry
string
serviceDescription
string
isBrickAndMortarStore
boolean
address
object
Show child attributes
representatives
object
Show child attributes
banks
object[]
Show child attributes
dateCreated
string<date-time>
dateUpdated
string<date-time> | null
declinedReason
string | null
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Modulus Labs API","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#4F46E5"},"logo":{"light":"https://mintcdn.com/moduluslabsinc/-g2JuykdH6NQMhpI/logo/light.svg?fit=max\u0026auto=format\u0026n=-g2JuykdH6NQMhpI\u0026q=85\u0026s=cdd5299c31d35441c6c6cab379ca0363","dark":"https://mintcdn.com/moduluslabsinc/-g2JuykdH6NQMhpI/logo/dark.svg?fit=max\u0026auto=format\u0026n=-g2JuykdH6NQMhpI\u0026q=85\u0026s=4be7c52f34d4ef4a0ca4b775b9e6792e"},"favicon":"https://mintcdn.com/moduluslabsinc/Hug35GYfKojSeqvX/favicon.svg?fit=max\u0026auto=format\u0026n=Hug35GYfKojSeqvX\u0026q=85\u0026s=65fea7bcc7fbf1163d727867c0623188","api":{"openapi":["api-reference/qr/openapi.json","api-reference/onboarding/openapi.json","api-reference/webhooks/openapi.json","api-reference/payment-webhooks/openapi.json","api-reference/terminal-gateway/openapi.json","api-reference/transaction-reporting/openapi.json","api-reference/ecom/openapi.json"],"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript","php","go","java","csharp"]}},"footer":{"socials":{"website":"https://moduluslabs.io"}},"search":{"prompt":"Search Modulus Labs API documentation..."},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@moduluslabs.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"moduluslabsinc","hasAudioNarration":false,"actualSubdomain":"moduluslabsinc","customDomains":["docs.moduluslabs.io"],"gitSource":{"type":"github","owner":"modulus-labs-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae44ceef49f5b7aedfd0755","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"Documentation","count":51},{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Webhooks API","count":27},{"language":"default","tag":"Ecom API","count":17},{"language":"default","tag":"Payment Webhooks","count":16},{"language":"default","tag":"Onboarding API","count":11},{"language":"default","tag":"Terminal Gateway API","count":10},{"language":"default","tag":"QR Ph Webhooks (Legacy)","count":10},{"language":"default","tag":"Transaction Reporting API","count":9},{"language":"default","tag":"Payment Links","count":8}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6979644a4ee895505c300ecd","deploymentId":"68ec6943b3c0516c1a13b4bf","questionText":"What is JWE","status":"active","generatedBy":"manual","createdAt":"2026-01-28T01:20:10.549Z","updatedAt":"2026-01-28T01:20:10.549Z","__v":0},{"_id":"6979643f4ee895505c300ea5","deploymentId":"68ec6943b3c0516c1a13b4bf","questionText":"How do I test before going live?","status":"active","generatedBy":"manual","createdAt":"2026-01-28T01:19:59.128Z","updatedAt":"2026-01-28T01:19:59.128Z","__v":0},{"_id":"6979643a4ee895505c300ea0","deploymentId":"68ec6943b3c0516c1a13b4bf","questionText":"What authentication does the API need?","status":"active","generatedBy":"manual","createdAt":"2026-01-28T01:19:54.290Z","updatedAt":"2026-01-28T01:19:54.290Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/onboarding/retrieve-onboarding-data","slug":"/api-reference/onboarding/retrieve-onboarding-data","pageMetadata":{"title":"Retrieve Onboarding Data","openapi":"GET /v2/onboard/{refNo}","description":"Retrieve complete merchant onboarding data by reference number","href":"/api-reference/onboarding/retrieve-onboarding-data"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve complete merchant onboarding data by reference number\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,Card,CardGroup,CodeBlock,Heading,Info,Step,Steps,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`Retrieves the complete onboarding data for a merchant using the onboarding reference number. This endpoint returns all information submitted during the onboarding process, including business details, representatives, bank accounts, and current approval status.`}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Use case:`}),` Check the status of a merchant’s onboarding application and retrieve all submitted information for review or updates.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`This endpoint requires JWT Bearer Token authentication.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`})]}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Authorization Required:`}),` The authenticated user must be the owner of the onboarding record. Only the user who created the onboarding record can retrieve it.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`onboarding-status-flow`,children:`Onboarding Status Flow`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`NEW`,children:_jsx(_components.p,{children:`Merchant has completed the onboarding form and submitted it for initial review. Awaiting admin approval.`})}),_jsx(Step,{title:`DECLINED (Optional)`,children:_jsxs(_components.p,{children:[`Admin reviewed the application and declined it. The `,_jsx(_components.code,{children:`declinedReason`}),` field contains the reason for rejection. Merchant needs to update their information.`]})}),_jsx(Step,{title:`PENDING (Optional)`,children:_jsx(_components.p,{children:`Merchant has updated their form after being declined and resubmitted for review. Awaiting admin re-approval.`})}),_jsx(Step,{title:`APPROVED`,children:_jsx(_components.p,{children:`Admin has approved the merchant’s onboarding application. Merchant can now process transactions.`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`bank-account-masking`,children:`Bank Account Masking`}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Security Feature:`}),` Bank account numbers are masked for security based on user roles.`]})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Full account numbers visible to:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The account that owns the record`}),`\n`,_jsx(_components.li,{children:`The account owner (authenticated user who created the onboarding record)`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Other users see:`}),` `,_jsx(_components.code,{children:`********1234`}),` (only last 4 digits visible)`]}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use Cases`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Check Application Status`,icon:`clipboard-check`,children:_jsx(_components.p,{children:`Monitor the approval status of your onboarding application`})}),_jsx(Card,{title:`Review Submitted Data`,icon:`eye`,children:_jsx(_components.p,{children:`Verify all information submitted during onboarding`})}),_jsx(Card,{title:`Handle Declined Applications`,icon:`triangle-exclamation`,children:_jsx(_components.p,{children:`Check the decline reason and prepare updated information`})}),_jsx(Card,{title:`Retrieve for Updates`,icon:`pen-to-square`,children:_jsx(_components.p,{children:`Get current data before submitting corrections or updates`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`troubleshooting`,children:`Troubleshooting`}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`Reference Number Mismatch Error`,icon:`triangle-exclamation`,id:`reference-number-mismatch-error`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Error:`}),` `,_jsx(_components.code,{children:`Onboarding reference number mismatch`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cause:`}),` You’re trying to access an onboarding record that doesn’t belong to your account`]}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Solution:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Verify you’re using the correct JWT token for the account that created this onboarding record`}),`\n`,_jsx(_components.li,{children:`Each onboarding record can only be accessed by the account that created it\nAccess is limited to records associated with your authenticated account.`}),`\n`]})]}),_jsxs(Accordion,{title:`Invalid UUID Format`,icon:`exclamation`,id:`invalid-uuid-format`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Error:`}),` `,_jsx(_components.code,{children:`Invalid onboarding reference number format`})]}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Solution:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Ensure the reference number is a valid UUID v4 format`}),`\n`,_jsxs(_components.li,{children:[`Example valid format: `,_jsx(_components.code,{children:`550e8400-e29b-41d4-a716-446655440000`})]}),`\n`,_jsx(_components.li,{children:`Check for extra spaces or incorrect characters`}),`\n`]})]}),_jsxs(Accordion,{title:`Record Not Found`,icon:`search`,id:`record-not-found`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Error:`}),` `,_jsx(_components.code,{children:`Onboarding record does not exist`})]}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Possible Causes:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The reference number is incorrect`}),`\n`,_jsx(_components.li,{children:`The onboarding record was deleted`}),`\n`,_jsx(_components.li,{children:`You’re using a sandbox reference number in production (or vice versa)`}),`\n`]}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Solution:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Double-check the reference number`}),`\n`,_jsx(_components.li,{children:`Verify you’re using the correct environment (sandbox vs production)`}),`\n`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next Steps`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Onboard Merchant`,icon:`plus`,href:`/api-reference/onboarding/onboard-merchant`,children:_jsx(_components.p,{children:`Create a new merchant onboarding record`})}),_jsx(Card,{title:`Create Account`,icon:`user-plus`,href:`/api-reference/onboarding/create-account`,children:_jsx(_components.p,{children:`Create an account before onboarding`})}),_jsx(Card,{title:`Authentication Guide`,icon:`key`,href:`/docs/onboarding/authentication`,children:_jsx(_components.p,{children:`Learn about JWT token authentication`})}),_jsx(Card,{title:`Error Handling`,icon:`triangle-exclamation`,href:`/docs/errors`,children:_jsx(_components.p,{children:`Handle API errors properly`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve Onboarding Data","openapi":"GET /v2/onboard/{refNo}","description":"Retrieve complete merchant onboarding data by reference number","href":"/api-reference/onboarding/retrieve-onboarding-data"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Onboarding Status Flow","slug":"onboarding-status-flow","depth":2,"children":[]},{"title":"Bank Account Masking","slug":"bank-account-masking","depth":2,"children":[]},{"title":"Use Cases","slug":"use-cases","depth":2,"children":[]},{"title":"Troubleshooting","slug":"troubleshooting","depth":2,"children":[]},{"title":"Next Steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"retrieveOnboardingData","summary":"Retrieve Onboarding Data","description":"Retrieve complete merchant onboarding data by reference number","tags":["Onboarding"],"security":["ff1247eb-c8c0-4573-95c8-24f9b3febef6"],"parameters":["c131b9e3-d8a4-42c1-afb9-c5f8adc50c1f"],"responses":{"200":"abb0c0ba-0e20-44ea-a188-07b75df0cadf","400":"4006907a-7ec9-430f-a708-f2ff14ecd4be","401":"c71648e5-534d-4649-8237-4f38b9800e59"},"method":"get","type":"path","servers":["782942e0-ba61-4a6d-9c63-1e825c9af994"],"path":"/v2/onboard/{refNo}","baseUrlOptions":["https://kyc.sbx.moduluslabs.io"],"title":"Retrieve Onboarding Data","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","php","go","java","csharp"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c131b9e3-d8a4-42c1-afb9-c5f8adc50c1f":{"name":"refNo","in":"path","required":true,"description":"The onboarding reference number (UUID v4 format)","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The onboarding reference number (UUID v4 format)","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"550e8400-e29b-41d4-a716-446655440000"}},"responses":{"abb0c0ba-0e20-44ea-a188-07b75df0cadf":{"description":"Onboarding data retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"onboardingStatus":{"type":"string","enum":["NEW","PENDING","APPROVED","DECLINED"],"uniqueKey":"onboardingStatus","typeLabel":"enum\u003cstring>"},"onboardingReferenceNumber":{"type":"string","format":"uuid","uniqueKey":"onboardingReferenceNumber","typeLabel":"string\u003cuuid>"},"merchantName":{"type":"string","uniqueKey":"merchantName","typeLabel":"string"},"legalName":{"type":"string","uniqueKey":"legalName","typeLabel":"string"},"businessHandle":{"type":"string","uniqueKey":"businessHandle","typeLabel":"string"},"modeOfPayments":{"type":"array","items":{"type":"string","uniqueKey":"modeOfPayments.items.[INDEX]","typeLabel":"string"},"uniqueKey":"modeOfPayments","typeLabel":"string[]"},"currency":{"type":"string","uniqueKey":"currency","typeLabel":"string"},"tin":{"type":"string","uniqueKey":"tin","typeLabel":"string"},"industry":{"type":"string","uniqueKey":"industry","typeLabel":"string"},"serviceDescription":{"type":"string","uniqueKey":"serviceDescription","typeLabel":"string"},"isBrickAndMortarStore":{"type":"boolean","uniqueKey":"isBrickAndMortarStore","typeLabel":"boolean"},"address":{"type":"object","required":["office"],"properties":{"office":{"type":"object","required":["city","line1","state","postalCode","contactNumber","barangay"],"properties":{"city":{"type":"string","maxLength":100,"description":"City","isRequired":true,"uniqueKey":"address.office.city","typeLabel":"string"},"line1":{"type":"string","maxLength":64,"description":"Street address","isRequired":true,"uniqueKey":"address.office.line1","typeLabel":"string"},"state":{"type":"string","maxLength":64,"description":"Province/State","isRequired":true,"uniqueKey":"address.office.state","typeLabel":"string"},"postalCode":{"type":"string","pattern":"^\\d{4,10}$","description":"Postal code (4-10 digits)","isRequired":true,"uniqueKey":"address.office.postalCode","typeLabel":"string"},"contactNumber":{"type":"string","pattern":"^\\d+$","maxLength":30,"description":"Contact number (digits only)","isRequired":true,"uniqueKey":"address.office.contactNumber","typeLabel":"string"},"barangay":{"type":"string","maxLength":200,"description":"Barangay","isRequired":true,"uniqueKey":"address.office.barangay","typeLabel":"string"},"buildingNameAndNumber":{"type":"string","maxLength":200,"description":"Building name and number","uniqueKey":"address.office.buildingNameAndNumber","typeLabel":"string"}},"isRequired":true,"uniqueKey":"address.office","typeLabel":"object"},"registered":{"type":"object","required":["city","line1","state","postalCode","contactNumber","barangay"],"properties":{"city":{"type":"string","maxLength":100,"description":"City","isRequired":true,"uniqueKey":"address.registered.city","typeLabel":"string"},"line1":{"type":"string","maxLength":64,"description":"Street address","isRequired":true,"uniqueKey":"address.registered.line1","typeLabel":"string"},"state":{"type":"string","maxLength":64,"description":"Province/State","isRequired":true,"uniqueKey":"address.registered.state","typeLabel":"string"},"postalCode":{"type":"string","pattern":"^\\d{4,10}$","description":"Postal code (4-10 digits)","isRequired":true,"uniqueKey":"address.registered.postalCode","typeLabel":"string"},"contactNumber":{"type":"string","pattern":"^\\d+$","maxLength":30,"description":"Contact number (digits only)","isRequired":true,"uniqueKey":"address.registered.contactNumber","typeLabel":"string"},"barangay":{"type":"string","maxLength":200,"description":"Barangay","isRequired":true,"uniqueKey":"address.registered.barangay","typeLabel":"string"},"buildingNameAndNumber":{"type":"string","maxLength":200,"description":"Building name and number","uniqueKey":"address.registered.buildingNameAndNumber","typeLabel":"string"}},"uniqueKey":"address.registered","typeLabel":"object"}},"uniqueKey":"address","typeLabel":"object"},"representatives":{"type":"object","required":["authorized"],"properties":{"authorized":{"type":"object","required":["firstName","lastName","emailAddress","contactNumber","dateOfBirth","position"],"properties":{"firstName":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"representatives.authorized.firstName","typeLabel":"string"},"lastName":{"type":"string","maxLength":100,"isRequired":true,"uniqueKey":"representatives.authorized.lastName","typeLabel":"string"},"emailAddress":{"type":"string","format":"email","maxLength":100,"isRequired":true,"uniqueKey":"representatives.authorized.emailAddress","typeLabel":"string\u003cemail>"},"contactNumber":{"type":"string","pattern":"^\\d+$","maxLength":30,"isRequired":true,"uniqueKey":"representatives.authorized.contactNumber","typeLabel":"string"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth (ISO 8601 date format)","isRequired":true,"uniqueKey":"representatives.authorized.dateOfBirth","typeLabel":"string\u003cdate>"},"position":{"type":"string","maxLength":100,"description":"Job position/title","isRequired":true,"uniqueKey":"representatives.authorized.position","typeLabel":"string"},"middleName":{"type":"string","maxLength":100,"uniqueKey":"representatives.authorized.middleName","typeLabel":"string"},"tin":{"type":"string","pattern":"^\\d+$","maxLength":20,"uniqueKey":"representatives.authorized.tin","typeLabel":"string"},"sss":{"type":"string","pattern":"^\\d{10}$","description":"SSS number (exactly 10 digits)","uniqueKey":"representatives.authorized.sss","typeLabel":"string"},"mothersMaidenName":{"type":"string","maxLength":255,"uniqueKey":"representatives.authorized.mothersMaidenName","typeLabel":"string"},"gender":{"type":"string","enum":["MALE","FEMALE"],"uniqueKey":"representatives.authorized.gender","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"representatives.authorized","typeLabel":"object"},"escalation":{"type":"object","properties":{"firstName":{"type":"string","maxLength":100,"uniqueKey":"representatives.escalation.firstName","typeLabel":"string"},"lastName":{"type":"string","maxLength":100,"uniqueKey":"representatives.escalation.lastName","typeLabel":"string"},"emailAddress":{"type":"string","format":"email","uniqueKey":"representatives.escalation.emailAddress","typeLabel":"string\u003cemail>"},"contactNumber":{"type":"string","pattern":"^\\d+$","uniqueKey":"representatives.escalation.contactNumber","typeLabel":"string"},"dateOfBirth":{"type":"string","format":"date","uniqueKey":"representatives.escalation.dateOfBirth","typeLabel":"string\u003cdate>"},"tin":{"type":"string","pattern":"^\\d{9}$","uniqueKey":"representatives.escalation.tin","typeLabel":"string"},"sss":{"type":"string","pattern":"^\\d{10}$","uniqueKey":"representatives.escalation.sss","typeLabel":"string"},"position":{"type":"string","uniqueKey":"representatives.escalation.position","typeLabel":"string"}},"uniqueKey":"representatives.escalation","typeLabel":"object"}},"uniqueKey":"representatives","typeLabel":"object"},"banks":{"type":"array","items":{"type":"object","required":["accountDepositType","currency"],"properties":{"accountDepositType":{"type":"string","enum":["BANK","PAYMAYA","GCASH","NO_ACCOUNT"],"description":"Type of deposit account","isRequired":true,"uniqueKey":"banks.items.[INDEX].accountDepositType","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["PHP","USD"],"description":"Currency of the bank account","isRequired":true,"uniqueKey":"banks.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"accountType":{"type":"string","enum":["SAVINGS","CHECKING_CURRENT"],"description":"Type of bank account (required when accountDepositType is BANK)","uniqueKey":"banks.items.[INDEX].accountType","typeLabel":"enum\u003cstring>"},"bankName":{"type":"string","maxLength":500,"description":"Name of the bank (required when accountDepositType is not NO_ACCOUNT)","uniqueKey":"banks.items.[INDEX].bankName","typeLabel":"string"},"accountName":{"type":"string","maxLength":500,"description":"Name on the bank account","uniqueKey":"banks.items.[INDEX].accountName","typeLabel":"string"},"accountNumber":{"type":"string","maxLength":500,"description":"Bank account number (will be encrypted)","uniqueKey":"banks.items.[INDEX].accountNumber","typeLabel":"string"}},"uniqueKey":"banks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"banks","typeLabel":"object[]"},"dateCreated":{"type":"string","format":"date-time","uniqueKey":"dateCreated","typeLabel":"string\u003cdate-time>"},"dateUpdated":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"dateUpdated.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"dateUpdated.oneOf.1","typeLabel":"null"}],"uniqueKey":"dateUpdated","typeLabel":"string\u003cdate-time> | null"},"declinedReason":{"oneOf":[{"type":"string","uniqueKey":"declinedReason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"declinedReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"declinedReason","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"onboardingStatus":"NEW","onboardingReferenceNumber":"3c90c3cc-0d44-4b50-8888-8dd25736052a","merchantName":"\u003cstring>","legalName":"\u003cstring>","businessHandle":"\u003cstring>","modeOfPayments":["\u003cstring>"],"currency":"\u003cstring>","tin":"\u003cstring>","industry":"\u003cstring>","serviceDescription":"\u003cstring>","isBrickAndMortarStore":true,"address":{"office":{"city":"\u003cstring>","line1":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","contactNumber":"\u003cstring>","barangay":"\u003cstring>","buildingNameAndNumber":"\u003cstring>"},"registered":{"city":"\u003cstring>","line1":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","contactNumber":"\u003cstring>","barangay":"\u003cstring>","buildingNameAndNumber":"\u003cstring>"}},"representatives":{"authorized":{"firstName":"\u003cstring>","lastName":"\u003cstring>","emailAddress":"jsmith@example.com","contactNumber":"\u003cstring>","dateOfBirth":"2023-12-25","position":"\u003cstring>","middleName":"\u003cstring>","tin":"\u003cstring>","sss":"\u003cstring>","mothersMaidenName":"\u003cstring>","gender":"MALE"},"escalation":{"firstName":"\u003cstring>","lastName":"\u003cstring>","emailAddress":"jsmith@example.com","contactNumber":"\u003cstring>","dateOfBirth":"2023-12-25","tin":"\u003cstring>","sss":"\u003cstring>","position":"\u003cstring>"}},"banks":[{"accountDepositType":"BANK","currency":"PHP","accountType":"SAVINGS","bankName":"\u003cstring>","accountName":"\u003cstring>","accountNumber":"\u003cstring>"}],"dateCreated":"2023-11-07T05:31:56Z","dateUpdated":"2023-11-07T05:31:56Z","declinedReason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4006907a-7ec9-430f-a708-f2ff14ecd4be":{"description":"Bad Request - Invalid reference number or record does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Error type","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"c71648e5-534d-4649-8237-4f38b9800e59":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Error type","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ff1247eb-c8c0-4573-95c8-24f9b3febef6":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Bearer token authentication","scopes":[]}}},"servers":{"782942e0-ba61-4a6d-9c63-1e825c9af994":{"url":"https://kyc.sbx.moduluslabs.io","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Bearer token authentication","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT Bearer token authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/onboarding/openapi.json"},"subdomain":"moduluslabsinc","siteName":"Modulus Labs API","title":"Retrieve Onboarding Data - Modulus Labs API","contextualStarterQuestions":[{"_id":"6a9a880970f2052206eddca6","deploymentId":"68ec6943b3c0516c1a13b4bf","questionText":"Who can retrieve onboarding data?","status":"active","generatedBy":"contextual","path":"api-reference/onboarding/retrieve-onboarding-data","createdAt":"2026-09-04T08:57:45.261Z","updatedAt":"2026-09-04T08:57:45.261Z","__v":0},{"_id":"6a9a880970f2052206eddca4","deploymentId":"68ec6943b3c0516c1a13b4bf","questionText":"How do I check onboarding status?","status":"active","generatedBy":"contextual","path":"api-reference/onboarding/retrieve-onboarding-data","createdAt":"2026-09-04T08:57:45.261Z","updatedAt":"2026-09-04T08:57:45.261Z","__v":0},{"_id":"6a9a880970f2052206eddca5","deploymentId":"68ec6943b3c0516c1a13b4bf","questionText":"What does bank account masking do?","status":"active","generatedBy":"contextual","path":"api-reference/onboarding/retrieve-onboarding-data","createdAt":"2026-09-04T08:57:45.261Z","updatedAt":"2026-09-04T08:57:45.261Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-04T08:57:19.906Z","originalFileLocation":"api-reference/onboarding/retrieve-onboarding-data.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=\"Retrieve complete merchant onboarding data by reference number\">\u003cmeta data-mint-head name=\"application-name\" content=\"Modulus Labs API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/moduluslabsinc/b12xWXezBf3lDUti/_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/moduluslabsinc/b12xWXezBf3lDUti/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/moduluslabsinc/b12xWXezBf3lDUti/_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/moduluslabsinc/b12xWXezBf3lDUti/_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/moduluslabsinc/b12xWXezBf3lDUti/_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/moduluslabsinc/b12xWXezBf3lDUti/_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/moduluslabsinc/b12xWXezBf3lDUti/_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/moduluslabsinc/b12xWXezBf3lDUti/_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/moduluslabsinc/b12xWXezBf3lDUti/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve Onboarding Data - Modulus Labs API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve complete merchant onboarding data by reference number\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Modulus Labs API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://moduluslabsinc.mintlify.site/_mintlify/api/og/v2?division=Onboarding+API\u0026amp;title=Retrieve+Onboarding+Data\u0026amp;description=Retrieve+complete+merchant+onboarding+data+by+reference+number\u0026amp;theme=0e23bf0ca39f87857ce30bad\u0026amp;signature=f6202f0594abb1d2a2ebc52a750efb883a146f37da810641b155a7adee6998c8\">\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=\"Retrieve Onboarding Data - Modulus Labs API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve complete merchant onboarding data by reference number\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://moduluslabsinc.mintlify.site/_mintlify/api/og/v2?division=Onboarding+API\u0026amp;title=Retrieve+Onboarding+Data\u0026amp;description=Retrieve+complete+merchant+onboarding+data+by+reference+number\u0026amp;theme=0e23bf0ca39f87857ce30bad\u0026amp;signature=f6202f0594abb1d2a2ebc52a750efb883a146f37da810641b155a7adee6998c8\">\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/moduluslabsinc/b12xWXezBf3lDUti/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Modulus Labs API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/onboarding/retrieve-onboarding-data.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.moduluslabs.io/#organization\",\"name\":\"Modulus Labs API\",\"url\":\"https://docs.moduluslabs.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/moduluslabsinc/-g2JuykdH6NQMhpI/logo/light.svg?fit=max\u0026auto=format\u0026n=-g2JuykdH6NQMhpI\u0026q=85\u0026s=cdd5299c31d35441c6c6cab379ca0363\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.moduluslabs.io#website\",\"name\":\"Modulus Labs API\",\"url\":\"https://docs.moduluslabs.io\",\"publisher\":{\"@id\":\"https://docs.moduluslabs.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data#webpage\",\"url\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data\",\"name\":\"Retrieve Onboarding Data\",\"description\":\"Retrieve complete merchant onboarding data by reference number\",\"dateModified\":\"2026-09-04T08:57:19.906Z\",\"isPartOf\":{\"@id\":\"https://docs.moduluslabs.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Onboarding API\",\"item\":\"https://docs.moduluslabs.io/api-reference/onboarding/ping\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve Onboarding Data\",\"item\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data#apireference\",\"headline\":\"Retrieve Onboarding Data\",\"name\":\"Retrieve Onboarding Data\",\"description\":\"Retrieve complete merchant onboarding data by reference number\",\"url\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data\",\"mainEntityOfPage\":{\"@id\":\"https://docs.moduluslabs.io/api-reference/onboarding/retrieve-onboarding-data#webpage\"},\"dateModified\":\"2026-09-04T08:57:19.906Z\",\"publisher\":{\"@id\":\"https://docs.moduluslabs.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.moduluslabs.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Modulus Labs API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Modulus Labs API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/onboarding/retrieve-onboarding-data.md","siteName":"Modulus Labs API","nav":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@moduluslabs.io"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"QR API","pages":[{"title":"Ping","openapi":"api-reference/qr/openapi.json GET /ping","href":"/api-reference/qr/ping"},{"title":"Create Dynamic QR Ph","openapi":"POST /v1/pay/qr","href":"/api-reference/qr/create"}]},{"group":"Webhooks API","pages":[{"group":"Payment Webhooks","pages":[{"title":"Create Webhook Endpoint","openapi":"api-reference/payment-webhooks/openapi.json POST /v1/webhook_endpoints","href":"/api-reference/payment-webhooks/create-endpoint"},{"title":"List Webhook Endpoints","openapi":"api-reference/payment-webhooks/openapi.json GET /v1/webhook_endpoints","href":"/api-reference/payment-webhooks/list-endpoints"},{"title":"Retrieve Webhook Endpoint","openapi":"api-reference/payment-webhooks/openapi.json GET /v1/webhook_endpoints/{id}","href":"/api-reference/payment-webhooks/get-endpoint"},{"title":"Update Webhook Endpoint","openapi":"api-reference/payment-webhooks/openapi.json PATCH /v1/webhook_endpoints/{id}","href":"/api-reference/payment-webhooks/update-endpoint"},{"title":"Delete Webhook Endpoint","openapi":"api-reference/payment-webhooks/openapi.json DELETE /v1/webhook_endpoints/{id}","href":"/api-reference/payment-webhooks/delete-endpoint"},{"title":"Retrieve Signing Secret","openapi":"api-reference/payment-webhooks/openapi.json GET /v1/webhook_endpoints/{id}/signing_secret","href":"/api-reference/payment-webhooks/get-signing-secret"},{"title":"Rotate Signing Secret","openapi":"api-reference/payment-webhooks/openapi.json POST /v1/webhook_endpoints/{id}/signing_secret/rotate","href":"/api-reference/payment-webhooks/rotate-signing-secret"},{"title":"List Webhook Events","openapi":"api-reference/payment-webhooks/openapi.json GET /v1/webhook_events","href":"/api-reference/payment-webhooks/list-events"},{"title":"Retrieve Webhook Event","openapi":"api-reference/payment-webhooks/openapi.json GET /v1/webhook_events/{event_id}","href":"/api-reference/payment-webhooks/get-event"},{"title":"Retrigger Webhook Event","openapi":"api-reference/payment-webhooks/openapi.json POST /v1/webhook_events/{event_id}/retrigger","href":"/api-reference/payment-webhooks/retrigger-event"}]},{"group":"QR Ph Webhooks (Legacy)","pages":[{"title":"Ping","openapi":"api-reference/webhooks/openapi.json GET /ping","href":"/api-reference/webhooks/ping"},{"title":"Create Webhook","openapi":"POST /v1/webhooks","href":"/api-reference/webhooks/create"},{"title":"List Webhooks","openapi":"GET /v1/webhooks","href":"/api-reference/webhooks/list"},{"title":"Update Webhook","openapi":"PUT /v1/webhooks/{id}","href":"/api-reference/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /v1/webhooks/{id}","href":"/api-reference/webhooks/delete"},{"title":"Simulate Webhook","openapi":"POST /v1/webhooks/qrph/simulate","href":"/api-reference/webhooks/simulate"}]}]},{"group":"Onboarding API","pages":[{"title":"Ping","openapi":"api-reference/onboarding/openapi.json GET /ping","href":"/api-reference/onboarding/ping"},{"title":"Create Account","openapi":"POST /v2/onboard/signup","href":"/api-reference/onboarding/create-account"},{"title":"Onboard Merchant","openapi":"POST /v2/onboard","description":"Onboard a merchant to accept payments through Modulus Labs","href":"/api-reference/onboarding/onboard-merchant"},{"title":"Retrieve Onboarding Data","openapi":"GET /v2/onboard/{refNo}","href":"/api-reference/onboarding/retrieve-onboarding-data"},{"title":"Retrieve Onboarding Status","openapi":"GET /v2/onboard/{refNo}/status","description":"Retrieve the current onboarding status for a merchant (lightweight endpoint)","href":"/api-reference/onboarding/retrieve-onboarding-status"},{"title":"Update Onboarding Data","openapi":"PUT /v2/onboard/{refNo}","href":"/api-reference/onboarding/update-onboarding-data"},{"title":"Upload Onboarding Files","openapi":"POST /v2/onboard/{merchantId}/files","href":"/api-reference/onboarding/upload-onboarding-files"}]},{"group":"Transaction Reporting API","pages":[{"title":"Ping","openapi":"api-reference/transaction-reporting/openapi.json GET /ping","href":"/api-reference/transaction-reporting/ping"},{"title":"List Transactions","openapi":"api-reference/transaction-reporting/openapi.json GET /v1/transactions","href":"/api-reference/transaction-reporting/list-transactions"},{"title":"Retrieve Transaction","openapi":"api-reference/transaction-reporting/openapi.json GET /v1/transactions/{id}","href":"/api-reference/transaction-reporting/get-transaction"},{"title":"List Merchants","openapi":"api-reference/transaction-reporting/openapi.json GET /v1/merchants","href":"/api-reference/transaction-reporting/list-merchants"},{"title":"List Branches","openapi":"api-reference/transaction-reporting/openapi.json GET /v1/branches","href":"/api-reference/transaction-reporting/list-branches"}]},{"group":"Terminal Gateway API","pages":[{"title":"List Terminals","openapi":"api-reference/terminal-gateway/openapi.json GET /v1/terminals","href":"/api-reference/terminal-gateway/list-terminals"},{"title":"Create Payment","openapi":"api-reference/terminal-gateway/openapi.json POST /v1/terminals/{terminalId}/payments","href":"/api-reference/terminal-gateway/create-payment"},{"title":"Retrieve Transaction","openapi":"api-reference/terminal-gateway/openapi.json GET /v1/transactions/{transactionId}","href":"/api-reference/terminal-gateway/get-transaction"}]},{"group":"Ecom API","pages":[{"group":"Payment Links","pages":[{"title":"Create Payment Link","openapi":"api-reference/ecom/openapi.json POST /payment-links","href":"/api-reference/ecom/create-payment-link"},{"title":"Retrieve Payment Link","openapi":"api-reference/ecom/openapi.json GET /payment-links/{id}","href":"/api-reference/ecom/retrieve-payment-link"},{"title":"List Payment Links","openapi":"api-reference/ecom/openapi.json GET /payment-links","href":"/api-reference/ecom/list-payment-links"},{"title":"Update Payment Link","openapi":"api-reference/ecom/openapi.json PATCH /payment-links/{id}","href":"/api-reference/ecom/update-payment-link"},{"title":"Cancel Payment Link","openapi":"api-reference/ecom/openapi.json POST /payment-links/{id}/cancel","href":"/api-reference/ecom/cancel-payment-link"}]},{"group":"JavaScript SDK","pages":[{"title":"Create Payment Intent","openapi":"api-reference/ecom/openapi.json POST /payment-intents","href":"/api-reference/ecom/create-payment-intent"},{"title":"Retrieve Payment Intent","openapi":"api-reference/ecom/openapi.json GET /payment-intents/{id}","href":"/api-reference/ecom/retrieve-payment-intent"}]}]}]}]},"basePath":"","title":"Retrieve Onboarding Data - Modulus Labs API","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DbeN8Wo6.js","utils-CwSb5Doc.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BmREeM3N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-AYjWerCj.js","snippetPresets-QD4ULQlp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Digj5cjF.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CiHrzluR.js","shallow-D7h7pFGg.js","getApiPlaygroundDisplay-mlxkpAUf.js","CodeSnippet-D2rH5lZI.js","CodeSnippets-B53ulOaL.js","Page-CqcDm2To.js","getPastedJson-DxGeNMih.js","icon-BHbyrebp.js","MethodPill-C7F_KEEJ.js","DuplicateIcon-j3c5-73z.js","createIcon-OvCnyFqD.js","DynamicMarkdown-DpAS3GCb.js","SectionHeading-DMPpdrvW.js","axios-vUo_bRtp.js","Markdown-D7pDRguu.js","clsx-2_c6mSt_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cu7_SikL.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ydqCcy4b.js"]}