{ "error": { "code": "BAD_REQUEST_ERROR", "description": "The file format is not accepted for this document type.", "source": "business", "step": "validation", "reason": "unsupported_media_type", "field": "file", "metadata": { "detected_type": "image/heic", "accept": "application/pdf,image/jpeg,image/png" } }}
Available in🇮🇳 India
Use this endpoint to store one KYC file for an account and get its file ID. Send that ID in the account’s documents with Update an Account to attach the file.
Handy Tips
Authenticate with the key and secret of your test pair or live pair. In the API playground, enter the test key as the username and its secret as the password. Use the live pair in live mode.
Send the request as multipart/form-data, with 1 file and its type. The endpoint takes a file only, never a link.
To share a document as a link instead, send its url in the account’s documents with Update an Account. Razorpay downloads it from there.
The upload alone does not attach the file. Razorpay verifies a document when you attach it to the account.
Razorpay keeps its own copy as the data fiduciary. Delete your copy once the upload succeeds, as your agreement with Razorpay requires.
Responses carry Cache-Control: private, no-store. Do not cache them.
Watch Out!A retry with the same X-Idempotency-Key, type and file returns the first response for up to 1 h, without storing a second file. The same key with a different type or file returns 400 with idempotency_key_reused. A refused or failed upload does not hold the key.
{ "error": { "code": "BAD_REQUEST_ERROR", "description": "The file format is not accepted for this document type.", "source": "business", "step": "validation", "reason": "unsupported_media_type", "field": "file", "metadata": { "detected_type": "image/heic", "accept": "application/pdf,image/jpeg,image/png" } }}
Path Parameters
string
required
The unique identifier of the account, acc_-prefixed. For example, acc_TcdGEzmfKQzEl1.
Request Parameters
Send file and type as multipart/form-data parts.
string
required
A unique key you generate for each upload, 16-64 printable ASCII characters long. A Universally Unique Identifier (UUID) works. Know more about idempotency.
file
required
The file, sent with its file name. Exactly 1 file of up to 20 MB:
Format: PDF, JPEG or PNG. Razorpay detects the format from the file content. cancelled_cheque_video takes a video instead: MP4, MOV, M4V, MKV, AVI, WMV, FLV or MPEG.
PDF: Up to 20 pages, without a password.
Image: Up to 50 megapixels.
File name: Up to 255 bytes, with no path separator or control character.
string
required
The document type of the file, sent once. The account’s requirements list the types each product needs. Know more about document types.
Response Parameters
string
Unique identifier for the file, file_ followed by 14 letters or digits.
string
Always document.
string
The document type of the file. Know more about the document types.
string
A signed link to download the file. Set only by Fetch One Document with include_signed_url=true. Otherwise null. It is also null when Razorpay could not create the link.
object
About the stored file.
string
Where the file came from. Possible values:
upload: You uploaded it.
ckyc: Razorpay downloaded it from the CKYC record.
string
The file name as you sent it.
string
The format Razorpay detected from the file content, such as image/jpeg. It can be null.
integer
File size in bytes. It can be null.
Errors
A required header is missing.
Code:400Reason:missing_headerX-Idempotency-Key is missing.Solution: Send X-Idempotency-Key with 16-64 printable ASCII characters. error.field names the header.
The value isn't in the right format.
Code:400Reason:invalid_formatX-Idempotency-Key is not 16-64 printable ASCII characters.Solution: Send a key of 16-64 printable ASCII characters.
The request is missing a required field.
Code:400Reason:invalid_requestThe body does not have exactly 1 file part and a type. error.field names the missing part.Solution: Send a multipart/form-data body with 1 file and its type.
Choose one of the allowed values.
Code:400Reason:invalid_optiontype is not a supported document type.Solution: Send a supported document type. Know more about document types.
The file can't be read. Upload it again.
Code:400Reason:invalid_fileThe file is empty or Razorpay cannot read it.Solution: Check that the file is complete and readable, then upload it again.
The file name isn't allowed.
Code:400Reason:invalid_file_nameThe file name has a path separator or a control character.Solution: Rename the file without path separators or control characters, then upload it again.
The file name is too long.
Code:400Reason:file_name_too_longThe file name is longer than 255 bytes, including the extension.Solution: Shorten the file name, then upload it again. metadata.max_bytes is the limit.
Upload the file without a password.
Code:400Reason:password_protected_fileThe PDF is password protected.Solution: Upload a copy without the password.
This request conflicts with an earlier one.
Code:400Reason:idempotency_key_reusedYou already used this X-Idempotency-Key for a different upload. A key is bound to its type and the exact file.Solution: Send a new X-Idempotency-Key for a different upload. Reuse a key only to retry the same upload.
The credentials aren't valid.
Code:401Reason:invalid_credentialsThe Authorization header is missing or is not Basic. Other causes are a key that is not a partner key or a wrong secret. A secret also stops working when it is revoked or its rotation window ends.Solution: Send your partner key and secret as HTTP Basic credentials. Check that the secret is current for the key.
Onboarding isn't enabled for this platform.
Code:403Reason:onboarding_not_enabledYour app does not have access to the Onboarding APIs in this mode. Razorpay may also have turned off your app’s access.Solution: Contact Razorpay to get access to the Onboarding APIs for your app in this mode.
Requests from this address aren't allowed.
Code:403Reason:ip_not_allowedThe request came from an IP address outside your app’s allowlist for its mode. Test mode checks the allowlist once it has an entry.Solution: Send requests from an IP range on your app’s allowlist for this mode. To use another range, add it to the allowlist on the Partner Dashboard.
The business has withdrawn this platform's access to its Razorpay account.
Code:403Reason:consent_withdrawnThrough Razorpay, the sub-merchant withdrew your permission to act on the account. Calls on this account never succeed again for your platform.Solution: Stop calling this account and update your records.
The requested resource doesn't exist.
Code:404Reason:not_foundNo account with this ID is mapped to your app in this mode. The account does not exist, belongs to another platform or belongs to a direct Razorpay merchant. It can also be a test account called in live mode.Solution: Check the ID in error.field. Use the ID of an account mapped to your app, in the same mode as your key.
The earlier request is still being processed.
Code:409Reason:idempotency_in_progressAn upload with this X-Idempotency-Key is still running.Solution: Wait for the time in the Retry-After header, then retry with the same key.
The file is too large.
Code:413Reason:file_too_largeThe file is larger than 20 MB.Solution: Upload a file of 20 MB or less. metadata.max_bytes is the limit in bytes.
The file format is not accepted for this document type.
Code:415Reason:unsupported_media_typeThe request has one of these problems:
The body is not multipart/form-data. error.field is Content-Type.
The file format is not accepted for this document type. error.field is file.
Solution: Send the body as multipart/form-data. For the file, use a format in metadata.accept. metadata.detected_type shows the format found.
Too many requests. Try again shortly.
Code:429Reason:rate_limitedYour app sent more requests than its rate limit allows.Solution: Wait for the time in the Retry-After header, then retry.
Something went wrong on our side. Try again.
Code:500Reason:internal_errorSomething went wrong inside Razorpay.Solution: Retry the request.
Last modified on November 18, 2026
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Razorpay","colors":{"primary":"#3395FF","light":"#66B2FF","dark":"#0B62C4"},"logo":{"light":"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/logo/light.svg?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=e0750375ee2004193a685f9f211963fe","dark":"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/logo/dark.svg?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=038b180f26d19ddb4eb40ede0cf84821","href":"https://razorpay.com/docs/"},"favicon":"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/favicon.png?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=9bebe786d3a21e9452fd2e31243e5fb3","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"basic"},"server":"https://api.razorpay.com"}},"navbar":{"links":[{"href":"https://razorpay.com/support/","label":"Support"},{"href":"https://razorpay.com/blog/","label":"Blog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.razorpay.com/"}},"footer":{"socials":{"x":"https://x.com/Razorpay","linkedin":"https://www.linkedin.com/company/razorpay","github":"https://github.com/razorpay","youtube":"https://www.youtube.com/razorpay"},"links":[{"header":"Products","items":[{"label":"Payment Gateway","href":"https://razorpay.com/payment-gateway"},{"label":"Payment Links","href":"https://razorpay.com/payment-links"},{"label":"RazorpayX","href":"https://razorpay.com/x"},{"label":"Payroll","href":"https://razorpay.com/payroll"}]},{"header":"Resources","items":[{"label":"Documentation","href":"https://razorpay.com/docs"},{"label":"API Reference","href":"https://razorpay.com/docs/api"},{"label":"Support","href":"https://razorpay.com/support"},{"label":"Blog","href":"https://razorpay.com/blog"}]},{"header":"Company","items":[{"label":"About Us","href":"https://razorpay.com/about"},{"label":"Careers","href":"https://razorpay.com/jobs"},{"label":"Pricing","href":"https://razorpay.com/pricing"}]}]},"seo":{"metatags":{"canonical":"https://razorpay.com/docs"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"razorpay-881012b3","hasAudioNarration":false,"actualSubdomain":"razorpay-881012b3","customDomains":["razorpay.com"],"gitSource":{"type":"github","owner":"razorpay-vendor-integrations","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"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":"6afdff139f57fed0468f83ea","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Payments","count":2084},{"language":"default","tag":"API Reference","count":842},{"language":"default","tag":"Payment Gateway","count":334},{"language":"default","tag":"Dashboard","count":287},{"language":"default","tag":"Subscriptions","count":234},{"language":"default","tag":"Payment Links","count":163},{"language":"default","tag":"Payouts","count":158},{"language":"default","tag":"Ecommerce Plugins","count":145},{"language":"default","tag":"Developer Tools","count":129},{"language":"default","tag":"Banking Plus","count":123}],"searchSettings":{"maxResults":8}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar ul.sidebar-group.mt-6,ul.sidebar-group.mt-6{margin-top:1rem}[data-component-part=\"callout-content\"]>[data-as=\"p\"]:first-child>strong,[data-component-part=\"callout-content\"]>[data-as=\"p\"]:first-child strong,[data-component-part=\"callout-content\"]>strong:first-child{font-size:1.125rem!important;font-weight:700!important;line-height:1.4!important}.error-code-cards [data-component-part=\"card-title\"]{display:inline-block!important;font-family:ui-monospace, \"SF Mono\", SFMono-Regular, Menlo, Consolas,\n \"Liberation Mono\", monospace!important;font-size:0.875rem!important;font-weight:600!important;line-height:1.3!important;padding:0.25rem 0.75rem!important;border-radius:9999px!important;background:rgba(107, 114, 128, 0.10)!important;border:1px solid rgba(107, 114, 128, 0.25)!important}.dark .error-code-cards [data-component-part=\"card-title\"]{background:rgba(255, 255, 255, 0.06)!important;border-color:rgba(255, 255, 255, 0.15)!important}[data-http-method]{font-weight:700!important;border-color:transparent!important}[data-http-method=\"get\"]{color:#15803d!important;background:rgba(74, 222, 128, 0.2)!important}[data-http-method=\"post\"]{color:#1d4ed8!important;background:rgba(96, 165, 250, 0.2)!important}[data-http-method=\"put\"]{color:#a16207!important;background:rgba(250, 204, 21, 0.2)!important}[data-http-method=\"patch\"]{color:#c2410c!important;background:rgba(251, 146, 60, 0.2)!important}[data-http-method=\"delete\"]{color:#b91c1c!important;background:rgba(248, 113, 113, 0.2)!important}.dark [data-http-method=\"get\"]{color:#4ade80!important}.dark [data-http-method=\"post\"]{color:#60a5fa!important}.dark [data-http-method=\"put\"]{color:#facc15!important}.dark [data-http-method=\"patch\"]{color:#fb923c!important}.dark [data-http-method=\"delete\"]{color:#f87171!important}ul.sidebar-group.mt-6{margin-top:5px}.sticky .panel:has(>.rzp-code-selector){display:grid;grid-auto-rows:minmax(0, 1fr);gap:1.5rem;overflow:hidden}.sticky:has(>.panel>.rzp-code-selector)>div:not(.panel){display:none}.rzp-code-selector{position:relative;display:flex;flex-direction:column;min-height:0;overflow:hidden;padding:0.125rem;border:1px solid rgba(3, 7, 18, 0.1);border-radius:1rem;background:rgb(244, 247, 250)}.dark .rzp-code-selector{border-color:rgba(255, 255, 255, 0.1);background:rgba(255, 255, 255, 0.05)}.rzp-code-selector-bar{display:flex;align-items:center;justify-content:space-between;gap:0.5rem;flex:none;flex-wrap:wrap;padding:0.25rem 4.25rem 0.375rem 0.5rem}.rzp-code-selector-field{position:relative;display:inline-flex;align-items:center;flex:0 0 auto}.rzp-code-selector-select{appearance:none;-webkit-appearance:none;min-width:max-content;padding:0.125rem 1.75rem 0.125rem 0.375rem;border:0;border-radius:0.5rem;background:transparent;color:var(--color-gray-600, #4b5563);font-size:0.75rem;font-weight:500;line-height:1.5rem;cursor:pointer}.dark .rzp-code-selector-select{color:var(--color-gray-300, #d1d5db)}.rzp-code-selector-select:hover{background:rgba(3, 7, 18, 0.05)}.dark .rzp-code-selector-select:hover{background:rgba(255, 255, 255, 0.08)}.rzp-code-selector-chevron{position:absolute;right:0.25rem;width:0.875rem;height:0.875rem;pointer-events:none;opacity:0.6}.rzp-code-selector-body{flex:1 1 auto;min-height:0;overflow-y:auto;overscroll-behavior:contain}.rzp-code-selector-body>.code-block{margin:0!important;min-width:0;border-radius:0 0 0.875rem 0.875rem;position:static!important}.rzp-code-selector-body [data-component-part=\"code-block-root\"]{border-radius:0 0 0.875rem 0.875rem}.rzp-code-selector-body .code-block-fade-overlay{display:none}.rzp-code-selector::after{content:\"\";position:absolute;inset:auto 0 0;height:2rem;border-radius:0 0 0.875rem 0.875rem;pointer-events:none;background:linear-gradient(to bottom, rgba(255, 255, 255, 0), #fff)}.dark .rzp-code-selector::after{background:linear-gradient(to bottom, rgba(11, 12, 14, 0), rgb(11, 12, 14))}.rzp-code-selector>.rzp-code-selector-body>.code-block>.absolute{top:0.5rem;right:0.75rem}#content:has(#error-title){visibility:hidden;animation:rzp-404-reveal 0s linear 4s forwards}.rzp-404-ready #content:has(#error-title){visibility:visible;animation:none}.rzp-404-redirecting #content:has(#error-title){visibility:hidden;animation:none}@keyframes rzp-404-reveal{to{visibility:visible}}.rzp-fallback-notice{display:flex;align-items:flex-start;gap:0.75rem;margin:0 0 1.5rem;padding:1rem 1.25rem;border:1px solid #fde68a;border-radius:1rem;background:#fefce8;color:#854d0e;font-size:0.875rem;line-height:1.5;animation:rzp-notice-in 0.25s ease-out}.dark .rzp-fallback-notice{border-color:rgba(234, 179, 8, 0.3);background:rgba(234, 179, 8, 0.1);color:#fde68a}.rzp-fallback-notice p{margin:0}.rzp-fallback-notice-icon{flex:none;width:1.25rem;height:1.25rem;margin-top:0.05rem;color:#ca8a04}.dark .rzp-fallback-notice-icon{color:#facc15}.rzp-fallback-notice-text{flex:1;min-width:0}.rzp-fallback-notice-title{font-weight:600}.rzp-fallback-notice-close{flex:none;display:inline-flex;padding:0.25rem;margin:-0.25rem -0.5rem -0.25rem 0;border-radius:0.5rem;color:inherit;opacity:0.7;cursor:pointer;transition:opacity 0.15s, background-color 0.15s}.rzp-fallback-notice-close:hover,.rzp-fallback-notice-close:focus-visible{opacity:1;background:rgba(202, 138, 4, 0.12)}.rzp-fallback-notice-close svg{width:1rem;height:1rem}@keyframes rzp-notice-in{from{transform:translateY(-4px)}}@media (prefers-reduced-motion: reduce){.rzp-fallback-notice{animation:none}}"},{"filePath":"static/docs-home/styles.css","href":"/docs/_mintlify/custom/razorpay-881012b3/5b8b615a0125ba7b/static/docs-home/styles.css"},{"filePath":"static/nav-more.css","content":"#navbar .nav-tabs{min-width:0;column-gap:1rem}#navbar .nav-tabs:not(.rzpn-more) .nav-tabs-item{display:block;flex:0 1 auto;min-width:3.5rem;min-width:calc-size(max-content, min(size, 5.25rem));white-space:nowrap;overflow:hidden;text-overflow:ellipsis;line-height:3rem}#navbar .nav-tabs:not(.rzpn-more) .nav-tabs-item>svg{display:inline-block;vertical-align:middle;margin:-2px 8px 0 0}#navbar .nav-tabs.rzpn-more .nav-tabs-item{flex:none;white-space:nowrap}#navbar .nav-tabs-item[data-rzpn-hidden]{display:none}#navbar .rzpn-more-wrap{position:relative;flex:none}#navbar .rzpn-more-wrap:not([hidden]){display:flex}#navbar .rzpn-more-menu:not([hidden]){display:flex;flex-direction:column}#navbar .rzpn-more-btn{background:none;border:0;padding:0;cursor:pointer;white-space:nowrap}#navbar .rzpn-more-menu{position:absolute;top:calc(100% - 4px);right:0;z-index:50;min-width:12rem;padding:6px;border-radius:12px;box-shadow:0 8px 24px rgba(0,0,0,.12)}#navbar .rzpn-more-menu a{display:flex;align-items:center;gap:8px;padding:8px 10px;border-radius:8px;white-space:nowrap}#navbar .rzpn-more-menu a:hover,#navbar .rzpn-more-menu a:focus-visible{background:rgba(127,127,127,.12)}"}],"page":{"pagePath":"api/partners/accounts/upload-document","slug":"/api/partners/accounts/upload-document","pageMetadata":{"title":"Upload a Document","description":"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.","api":"POST /v1/accounts/{account_id}/documents","href":"/api/partners/accounts/upload-document"},"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: \"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.\"\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={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,Heading,Info,ParamField,ResponseField,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(`div`,{style:{display:`flex`,flexWrap:`wrap`,alignItems:`center`,gap:`0.35rem 0.9rem`,border:`1px solid rgba(128,128,128,0.28)`,borderRadius:`0.5rem`,padding:`0.45rem 0.75rem`,margin:`0 0 1.25rem`,fontSize:`0.875rem`},children:[_jsx(`span`,{style:{fontWeight:600},children:`Available in`}),_jsx(`span`,{children:`🇮🇳 India`})]}),`\n`,_jsxs(_components.p,{children:[`Use this endpoint to store one KYC file for an account and get its file ID. Send that ID in the account’s `,_jsx(_components.code,{children:`documents`}),` with `,_jsx(_components.a,{href:`/api/partners/accounts/update`,children:`Update an Account`}),` to attach the file.`]}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Handy Tips`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Authenticate with the key and secret of your test pair or live pair. In the API playground, enter the test key as the username and its secret as the password. Use the live pair in live mode.`}),`\n`,_jsxs(_components.li,{children:[`Send the request as `,_jsx(_components.code,{children:`multipart/form-data`}),`, with 1 `,_jsx(_components.code,{children:`file`}),` and its `,_jsx(_components.code,{children:`type`}),`. The endpoint takes a file only, never a link.`]}),`\n`,_jsxs(_components.li,{children:[`To share a document as a link instead, send its `,_jsx(_components.code,{children:`url`}),` in the account’s `,_jsx(_components.code,{children:`documents`}),` with `,_jsx(_components.a,{href:`/api/partners/accounts/update`,children:`Update an Account`}),`. Razorpay downloads it from there.`]}),`\n`,_jsx(_components.li,{children:`The upload alone does not attach the file. Razorpay verifies a document when you attach it to the account.`}),`\n`,_jsx(_components.li,{children:`Razorpay keeps its own copy as the data fiduciary. Delete your copy once the upload succeeds, as your agreement with Razorpay requires.`}),`\n`,_jsxs(_components.li,{children:[`Responses carry `,_jsx(_components.code,{children:`Cache-Control: private, no-store`}),`. Do not cache them.`]}),`\n`]})]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.p,{children:[`A retry with the same `,_jsx(_components.code,{children:`X-Idempotency-Key`}),`, `,_jsx(_components.code,{children:`type`}),` and file returns the first response for up to 1 h, without storing a second file. The same key with a different `,_jsx(_components.code,{children:`type`}),` or file returns `,_jsx(_components.code,{children:`400`}),` with `,_jsx(_components.code,{children:`idempotency_key_reused`}),`. A refused or failed upload does not hold the key.`]})]}),`\n`,`\n`,`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`account_id`,type:`string`,required:true,id:`param-account-id`,children:_jsxs(_components.p,{children:[`The unique identifier of the account, `,_jsx(_components.code,{children:`acc_`}),`-prefixed. For example, `,_jsx(_components.code,{children:`acc_TcdGEzmfKQzEl1`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`request-parameters`,children:`Request Parameters`}),`\n`,_jsxs(_components.p,{children:[`Send `,_jsx(_components.code,{children:`file`}),` and `,_jsx(_components.code,{children:`type`}),` as `,_jsx(_components.code,{children:`multipart/form-data`}),` parts.`]}),`\n`,_jsx(ParamField,{header:`X-Idempotency-Key`,type:`string`,required:true,id:`param-x-idempotency-key`,children:_jsxs(_components.p,{children:[`A unique key you generate for each upload, 16-64 printable ASCII characters long. A Universally Unique Identifier (UUID) works. Know more about `,_jsx(_components.a,{href:`/api/partners/accounts#idempotency`,children:`idempotency`}),`.`]})}),`\n`,_jsxs(ParamField,{body:`file`,type:`file`,required:true,id:`param-file`,children:[_jsx(_components.p,{children:`The file, sent with its file name. Exactly 1 file of up to 20 MB:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Format:`}),` PDF, JPEG or PNG. Razorpay detects the format from the file content. `,_jsx(_components.code,{children:`cancelled_cheque_video`}),` takes a video instead: MP4, MOV, M4V, MKV, AVI, WMV, FLV or MPEG.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`PDF:`}),` Up to 20 pages, without a password.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Image:`}),` Up to 50 megapixels.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`File name:`}),` Up to 255 bytes, with no path separator or control character.`]}),`\n`]})]}),`\n`,_jsx(ParamField,{body:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`The document type of the file, sent once. The account’s `,_jsx(_components.code,{children:`requirements`}),` list the types each product needs. Know more about `,_jsx(_components.a,{href:`/api/partners/accounts/document-entity`,children:`document types`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response-parameters`,children:`Response Parameters`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsxs(_components.p,{children:[`Unique identifier for the file, `,_jsx(_components.code,{children:`file_`}),` followed by 14 letters or digits.`]})}),`\n`,_jsx(ResponseField,{name:`entity`,type:`string`,id:`param-entity`,children:_jsxs(_components.p,{children:[`Always `,_jsx(_components.code,{children:`document`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-1`,children:_jsxs(_components.p,{children:[`The document type of the file. Know more about the `,_jsx(_components.a,{href:`/api/partners/accounts/document-entity#document-types`,children:`document types`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url`,children:_jsxs(_components.p,{children:[`A signed link to download the file. Set only by `,_jsx(_components.a,{href:`/api/partners/accounts/fetch-document`,children:`Fetch One Document`}),` with `,_jsx(_components.code,{children:`include_signed_url=true`}),`. Otherwise `,_jsx(_components.code,{children:`null`}),`. It is also `,_jsx(_components.code,{children:`null`}),` when Razorpay could not create the link.`]})}),`\n`,_jsx(ResponseField,{name:`metadata`,type:`object`,id:`param-metadata`,children:_jsx(_components.p,{children:`About the stored file.`})}),`\n`,_jsxs(ResponseField,{name:`metadata.source`,type:`string`,id:`param-metadata-source`,children:[_jsx(_components.p,{children:`Where the file came from. Possible values:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`upload`}),`: You uploaded it.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`ckyc`}),`: Razorpay downloaded it from the CKYC record.`]}),`\n`]})]}),`\n`,_jsx(ResponseField,{name:`metadata.file_name`,type:`string`,id:`param-metadata-file-name`,children:_jsx(_components.p,{children:`The file name as you sent it.`})}),`\n`,_jsx(ResponseField,{name:`metadata.mime_type`,type:`string`,id:`param-metadata-mime-type`,children:_jsxs(_components.p,{children:[`The format Razorpay detected from the file content, such as `,_jsx(_components.code,{children:`image/jpeg`}),`. It can be `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`metadata.size_bytes`,type:`integer`,id:`param-metadata-size-bytes`,children:_jsxs(_components.p,{children:[`File size in bytes. It can be `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`A required header is missing.`,id:`a-required-header-is-missing`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`missing_header`})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`X-Idempotency-Key`}),` is missing.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` with 16-64 printable ASCII characters. `,_jsx(_components.code,{children:`error.field`}),` names the header.`]})]}),_jsxs(Accordion,{title:`The value isn't in the right format.`,id:`the-value-isnt-in-the-right-format`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_format`})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`X-Idempotency-Key`}),` is not 16-64 printable ASCII characters.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a key of 16-64 printable ASCII characters.`]})]}),_jsxs(Accordion,{title:`The request is missing a required field.`,id:`the-request-is-missing-a-required-field`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_request`})]}),_jsxs(_components.p,{children:[`The body does not have exactly 1 `,_jsx(_components.code,{children:`file`}),` part and a `,_jsx(_components.code,{children:`type`}),`. `,_jsx(_components.code,{children:`error.field`}),` names the missing part.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a `,_jsx(_components.code,{children:`multipart/form-data`}),` body with 1 `,_jsx(_components.code,{children:`file`}),` and its `,_jsx(_components.code,{children:`type`}),`.`]})]}),_jsxs(Accordion,{title:`Choose one of the allowed values.`,id:`choose-one-of-the-allowed-values`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_option`})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`type`}),` is not a supported document type.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a supported document type. Know more about `,_jsx(_components.a,{href:`/api/partners/accounts/document-entity`,children:`document types`}),`.`]})]}),_jsxs(Accordion,{title:`The file can't be read. Upload it again.`,id:`the-file-cant-be-read-upload-it-again`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_file`})]}),_jsx(_components.p,{children:`The file is empty or Razorpay cannot read it.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Check that the file is complete and readable, then upload it again.`]})]}),_jsxs(Accordion,{title:`The file name isn't allowed.`,id:`the-file-name-isnt-allowed`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_file_name`})]}),_jsx(_components.p,{children:`The file name has a path separator or a control character.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Rename the file without path separators or control characters, then upload it again.`]})]}),_jsxs(Accordion,{title:`The file name is too long.`,id:`the-file-name-is-too-long`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`file_name_too_long`})]}),_jsx(_components.p,{children:`The file name is longer than 255 bytes, including the extension.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Shorten the file name, then upload it again. `,_jsx(_components.code,{children:`metadata.max_bytes`}),` is the limit.`]})]}),_jsxs(Accordion,{title:`Upload the file without a password.`,id:`upload-the-file-without-a-password`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`password_protected_file`})]}),_jsx(_components.p,{children:`The PDF is password protected.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Upload a copy without the password.`]})]}),_jsxs(Accordion,{title:`This request conflicts with an earlier one.`,id:`this-request-conflicts-with-an-earlier-one`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`idempotency_key_reused`})]}),_jsxs(_components.p,{children:[`You already used this `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` for a different upload. A key is bound to its `,_jsx(_components.code,{children:`type`}),` and the exact file.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a new `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` for a different upload. Reuse a key only to retry the same upload.`]})]}),_jsxs(Accordion,{title:`The credentials aren't valid.`,id:`the-credentials-arent-valid`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`401`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_credentials`})]}),_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`Authorization`}),` header is missing or is not Basic. Other causes are a key that is not a partner key or a wrong secret. A secret also stops working when it is revoked or its rotation window ends.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send your partner key and secret as HTTP Basic credentials. Check that the secret is current for the key.`]})]}),_jsxs(Accordion,{title:`Onboarding isn't enabled for this platform.`,id:`onboarding-isnt-enabled-for-this-platform`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`403`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`onboarding_not_enabled`})]}),_jsx(_components.p,{children:`Your app does not have access to the Onboarding APIs in this mode. Razorpay may also have turned off your app’s access.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Contact Razorpay to get access to the Onboarding APIs for your app in this mode.`]})]}),_jsxs(Accordion,{title:`Requests from this address aren't allowed.`,id:`requests-from-this-address-arent-allowed`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`403`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`ip_not_allowed`})]}),_jsx(_components.p,{children:`The request came from an IP address outside your app’s allowlist for its mode. Test mode checks the allowlist once it has an entry.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send requests from an IP range on your app’s allowlist for this mode. To use another range, add it to the allowlist on the Partner Dashboard.`]})]}),_jsxs(Accordion,{title:`The business has withdrawn this platform's access to its Razorpay account.`,id:`the-business-has-withdrawn-this-platforms-access-to-its-razorpay-account`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`403`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`consent_withdrawn`})]}),_jsx(_components.p,{children:`Through Razorpay, the sub-merchant withdrew your permission to act on the account. Calls on this account never succeed again for your platform.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Stop calling this account and update your records.`]})]}),_jsxs(Accordion,{title:`The requested resource doesn't exist.`,id:`the-requested-resource-doesnt-exist`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`404`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`not_found`})]}),_jsx(_components.p,{children:`No account with this ID is mapped to your app in this mode. The account does not exist, belongs to another platform or belongs to a direct Razorpay merchant. It can also be a test account called in live mode.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Check the ID in `,_jsx(_components.code,{children:`error.field`}),`. Use the ID of an account mapped to your app, in the same mode as your key.`]})]}),_jsxs(Accordion,{title:`The earlier request is still being processed.`,id:`the-earlier-request-is-still-being-processed`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`409`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`idempotency_in_progress`})]}),_jsxs(_components.p,{children:[`An upload with this `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` is still running.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Wait for the time in the `,_jsx(_components.code,{children:`Retry-After`}),` header, then retry with the same key.`]})]}),_jsxs(Accordion,{title:`The file is too large.`,id:`the-file-is-too-large`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`413`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`file_too_large`})]}),_jsx(_components.p,{children:`The file is larger than 20 MB.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Upload a file of 20 MB or less. `,_jsx(_components.code,{children:`metadata.max_bytes`}),` is the limit in bytes.`]})]}),_jsxs(Accordion,{title:`The file format is not accepted for this document type.`,id:`the-file-format-is-not-accepted-for-this-document-type`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`415`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`unsupported_media_type`})]}),_jsx(_components.p,{children:`The request has one of these problems:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The body is not `,_jsx(_components.code,{children:`multipart/form-data`}),`. `,_jsx(_components.code,{children:`error.field`}),` is `,_jsx(_components.code,{children:`Content-Type`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The file format is not accepted for this document type. `,_jsx(_components.code,{children:`error.field`}),` is `,_jsx(_components.code,{children:`file`}),`.`]}),`\n`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send the body as `,_jsx(_components.code,{children:`multipart/form-data`}),`. For the file, use a format in `,_jsx(_components.code,{children:`metadata.accept`}),`. `,_jsx(_components.code,{children:`metadata.detected_type`}),` shows the format found.`]})]}),_jsxs(Accordion,{title:`Too many requests. Try again shortly.`,id:`too-many-requests-try-again-shortly`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`429`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`rate_limited`})]}),_jsx(_components.p,{children:`Your app sent more requests than its rate limit allows.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Wait for the time in the `,_jsx(_components.code,{children:`Retry-After`}),` header, then retry.`]})]}),_jsxs(Accordion,{title:`Something went wrong on our side. Try again.`,id:`something-went-wrong-on-our-side-try-again`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`500`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`internal_error`})]}),_jsx(_components.p,{children:`Something went wrong inside Razorpay.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Retry the request.`]})]})]})]})}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":"Upload a Document","description":"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.","api":"POST /v1/accounts/{account_id}/documents","href":"/api/partners/accounts/upload-document"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Heading,Info,ParamField,RequestExample,ResponseExample,ResponseField,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(`div`,{style:{display:`flex`,flexWrap:`wrap`,alignItems:`center`,gap:`0.35rem 0.9rem`,border:`1px solid rgba(128,128,128,0.28)`,borderRadius:`0.5rem`,padding:`0.45rem 0.75rem`,margin:`0 0 1.25rem`,fontSize:`0.875rem`},children:[_jsx(`span`,{style:{fontWeight:600},children:`Available in`}),_jsx(`span`,{children:`🇮🇳 India`})]}),`\n`,_jsxs(_components.p,{children:[`Use this endpoint to store one KYC file for an account and get its file ID. Send that ID in the account’s `,_jsx(_components.code,{children:`documents`}),` with `,_jsx(_components.a,{href:`/api/partners/accounts/update`,children:`Update an Account`}),` to attach the file.`]}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Handy Tips`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Authenticate with the key and secret of your test pair or live pair. In the API playground, enter the test key as the username and its secret as the password. Use the live pair in live mode.`}),`\n`,_jsxs(_components.li,{children:[`Send the request as `,_jsx(_components.code,{children:`multipart/form-data`}),`, with 1 `,_jsx(_components.code,{children:`file`}),` and its `,_jsx(_components.code,{children:`type`}),`. The endpoint takes a file only, never a link.`]}),`\n`,_jsxs(_components.li,{children:[`To share a document as a link instead, send its `,_jsx(_components.code,{children:`url`}),` in the account’s `,_jsx(_components.code,{children:`documents`}),` with `,_jsx(_components.a,{href:`/api/partners/accounts/update`,children:`Update an Account`}),`. Razorpay downloads it from there.`]}),`\n`,_jsx(_components.li,{children:`The upload alone does not attach the file. Razorpay verifies a document when you attach it to the account.`}),`\n`,_jsx(_components.li,{children:`Razorpay keeps its own copy as the data fiduciary. Delete your copy once the upload succeeds, as your agreement with Razorpay requires.`}),`\n`,_jsxs(_components.li,{children:[`Responses carry `,_jsx(_components.code,{children:`Cache-Control: private, no-store`}),`. Do not cache them.`]}),`\n`]})]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.p,{children:[`A retry with the same `,_jsx(_components.code,{children:`X-Idempotency-Key`}),`, `,_jsx(_components.code,{children:`type`}),` and file returns the first response for up to 1 h, without storing a second file. The same key with a different `,_jsx(_components.code,{children:`type`}),` or file returns `,_jsx(_components.code,{children:`400`}),` with `,_jsx(_components.code,{children:`idempotency_key_reused`}),`. A refused or failed upload does not hold the key.`]})]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`Curl`,numberOfLines:`5`,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:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.razorpay.com/v1/accounts/acc_TcdGEzmfKQzEl1/documents`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-u `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`rzp_test_partner_[CLIENT_ID]:[CLIENT_SECRET]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"X-Idempotency-Key: [UNIQUE_KEY]\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-F `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type=aadhaar_front\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-F `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"file=@aadhaar-front.jpg\"`})]}),`\n`]})})})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`Success`,numberOfLines:`12`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"file_Qx7Lm2Kd9Tz4Ab\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"entity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"document\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"aadhaar_front\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"upload\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"file_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"aadhaar-front.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mime_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"image/jpeg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"size_bytes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`183422`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Failure`,numberOfLines:`14`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"BAD_REQUEST_ERROR\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The file format is not accepted for this document type.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"business\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"step\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"validation\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reason\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"unsupported_media_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"file\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detected_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"image/heic\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"accept\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/pdf,image/jpeg,image/png\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`account_id`,type:`string`,required:true,id:`param-account-id`,children:_jsxs(_components.p,{children:[`The unique identifier of the account, `,_jsx(_components.code,{children:`acc_`}),`-prefixed. For example, `,_jsx(_components.code,{children:`acc_TcdGEzmfKQzEl1`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`request-parameters`,children:`Request Parameters`}),`\n`,_jsxs(_components.p,{children:[`Send `,_jsx(_components.code,{children:`file`}),` and `,_jsx(_components.code,{children:`type`}),` as `,_jsx(_components.code,{children:`multipart/form-data`}),` parts.`]}),`\n`,_jsx(ParamField,{header:`X-Idempotency-Key`,type:`string`,required:true,id:`param-x-idempotency-key`,children:_jsxs(_components.p,{children:[`A unique key you generate for each upload, 16-64 printable ASCII characters long. A Universally Unique Identifier (UUID) works. Know more about `,_jsx(_components.a,{href:`/api/partners/accounts#idempotency`,children:`idempotency`}),`.`]})}),`\n`,_jsxs(ParamField,{body:`file`,type:`file`,required:true,id:`param-file`,children:[_jsx(_components.p,{children:`The file, sent with its file name. Exactly 1 file of up to 20 MB:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Format:`}),` PDF, JPEG or PNG. Razorpay detects the format from the file content. `,_jsx(_components.code,{children:`cancelled_cheque_video`}),` takes a video instead: MP4, MOV, M4V, MKV, AVI, WMV, FLV or MPEG.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`PDF:`}),` Up to 20 pages, without a password.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Image:`}),` Up to 50 megapixels.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`File name:`}),` Up to 255 bytes, with no path separator or control character.`]}),`\n`]})]}),`\n`,_jsx(ParamField,{body:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`The document type of the file, sent once. The account’s `,_jsx(_components.code,{children:`requirements`}),` list the types each product needs. Know more about `,_jsx(_components.a,{href:`/api/partners/accounts/document-entity`,children:`document types`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response-parameters`,children:`Response Parameters`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsxs(_components.p,{children:[`Unique identifier for the file, `,_jsx(_components.code,{children:`file_`}),` followed by 14 letters or digits.`]})}),`\n`,_jsx(ResponseField,{name:`entity`,type:`string`,id:`param-entity`,children:_jsxs(_components.p,{children:[`Always `,_jsx(_components.code,{children:`document`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-1`,children:_jsxs(_components.p,{children:[`The document type of the file. Know more about the `,_jsx(_components.a,{href:`/api/partners/accounts/document-entity#document-types`,children:`document types`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url`,children:_jsxs(_components.p,{children:[`A signed link to download the file. Set only by `,_jsx(_components.a,{href:`/api/partners/accounts/fetch-document`,children:`Fetch One Document`}),` with `,_jsx(_components.code,{children:`include_signed_url=true`}),`. Otherwise `,_jsx(_components.code,{children:`null`}),`. It is also `,_jsx(_components.code,{children:`null`}),` when Razorpay could not create the link.`]})}),`\n`,_jsx(ResponseField,{name:`metadata`,type:`object`,id:`param-metadata`,children:_jsx(_components.p,{children:`About the stored file.`})}),`\n`,_jsxs(ResponseField,{name:`metadata.source`,type:`string`,id:`param-metadata-source`,children:[_jsx(_components.p,{children:`Where the file came from. Possible values:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`upload`}),`: You uploaded it.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`ckyc`}),`: Razorpay downloaded it from the CKYC record.`]}),`\n`]})]}),`\n`,_jsx(ResponseField,{name:`metadata.file_name`,type:`string`,id:`param-metadata-file-name`,children:_jsx(_components.p,{children:`The file name as you sent it.`})}),`\n`,_jsx(ResponseField,{name:`metadata.mime_type`,type:`string`,id:`param-metadata-mime-type`,children:_jsxs(_components.p,{children:[`The format Razorpay detected from the file content, such as `,_jsx(_components.code,{children:`image/jpeg`}),`. It can be `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`metadata.size_bytes`,type:`integer`,id:`param-metadata-size-bytes`,children:_jsxs(_components.p,{children:[`File size in bytes. It can be `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`A required header is missing.`,id:`a-required-header-is-missing`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`missing_header`})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`X-Idempotency-Key`}),` is missing.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` with 16-64 printable ASCII characters. `,_jsx(_components.code,{children:`error.field`}),` names the header.`]})]}),_jsxs(Accordion,{title:`The value isn't in the right format.`,id:`the-value-isnt-in-the-right-format`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_format`})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`X-Idempotency-Key`}),` is not 16-64 printable ASCII characters.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a key of 16-64 printable ASCII characters.`]})]}),_jsxs(Accordion,{title:`The request is missing a required field.`,id:`the-request-is-missing-a-required-field`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_request`})]}),_jsxs(_components.p,{children:[`The body does not have exactly 1 `,_jsx(_components.code,{children:`file`}),` part and a `,_jsx(_components.code,{children:`type`}),`. `,_jsx(_components.code,{children:`error.field`}),` names the missing part.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a `,_jsx(_components.code,{children:`multipart/form-data`}),` body with 1 `,_jsx(_components.code,{children:`file`}),` and its `,_jsx(_components.code,{children:`type`}),`.`]})]}),_jsxs(Accordion,{title:`Choose one of the allowed values.`,id:`choose-one-of-the-allowed-values`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_option`})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`type`}),` is not a supported document type.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a supported document type. Know more about `,_jsx(_components.a,{href:`/api/partners/accounts/document-entity`,children:`document types`}),`.`]})]}),_jsxs(Accordion,{title:`The file can't be read. Upload it again.`,id:`the-file-cant-be-read-upload-it-again`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_file`})]}),_jsx(_components.p,{children:`The file is empty or Razorpay cannot read it.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Check that the file is complete and readable, then upload it again.`]})]}),_jsxs(Accordion,{title:`The file name isn't allowed.`,id:`the-file-name-isnt-allowed`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_file_name`})]}),_jsx(_components.p,{children:`The file name has a path separator or a control character.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Rename the file without path separators or control characters, then upload it again.`]})]}),_jsxs(Accordion,{title:`The file name is too long.`,id:`the-file-name-is-too-long`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`file_name_too_long`})]}),_jsx(_components.p,{children:`The file name is longer than 255 bytes, including the extension.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Shorten the file name, then upload it again. `,_jsx(_components.code,{children:`metadata.max_bytes`}),` is the limit.`]})]}),_jsxs(Accordion,{title:`Upload the file without a password.`,id:`upload-the-file-without-a-password`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`password_protected_file`})]}),_jsx(_components.p,{children:`The PDF is password protected.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Upload a copy without the password.`]})]}),_jsxs(Accordion,{title:`This request conflicts with an earlier one.`,id:`this-request-conflicts-with-an-earlier-one`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`400`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`idempotency_key_reused`})]}),_jsxs(_components.p,{children:[`You already used this `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` for a different upload. A key is bound to its `,_jsx(_components.code,{children:`type`}),` and the exact file.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send a new `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` for a different upload. Reuse a key only to retry the same upload.`]})]}),_jsxs(Accordion,{title:`The credentials aren't valid.`,id:`the-credentials-arent-valid`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`401`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`invalid_credentials`})]}),_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`Authorization`}),` header is missing or is not Basic. Other causes are a key that is not a partner key or a wrong secret. A secret also stops working when it is revoked or its rotation window ends.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send your partner key and secret as HTTP Basic credentials. Check that the secret is current for the key.`]})]}),_jsxs(Accordion,{title:`Onboarding isn't enabled for this platform.`,id:`onboarding-isnt-enabled-for-this-platform`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`403`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`onboarding_not_enabled`})]}),_jsx(_components.p,{children:`Your app does not have access to the Onboarding APIs in this mode. Razorpay may also have turned off your app’s access.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Contact Razorpay to get access to the Onboarding APIs for your app in this mode.`]})]}),_jsxs(Accordion,{title:`Requests from this address aren't allowed.`,id:`requests-from-this-address-arent-allowed`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`403`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`ip_not_allowed`})]}),_jsx(_components.p,{children:`The request came from an IP address outside your app’s allowlist for its mode. Test mode checks the allowlist once it has an entry.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send requests from an IP range on your app’s allowlist for this mode. To use another range, add it to the allowlist on the Partner Dashboard.`]})]}),_jsxs(Accordion,{title:`The business has withdrawn this platform's access to its Razorpay account.`,id:`the-business-has-withdrawn-this-platforms-access-to-its-razorpay-account`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`403`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`consent_withdrawn`})]}),_jsx(_components.p,{children:`Through Razorpay, the sub-merchant withdrew your permission to act on the account. Calls on this account never succeed again for your platform.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Stop calling this account and update your records.`]})]}),_jsxs(Accordion,{title:`The requested resource doesn't exist.`,id:`the-requested-resource-doesnt-exist`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`404`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`not_found`})]}),_jsx(_components.p,{children:`No account with this ID is mapped to your app in this mode. The account does not exist, belongs to another platform or belongs to a direct Razorpay merchant. It can also be a test account called in live mode.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Check the ID in `,_jsx(_components.code,{children:`error.field`}),`. Use the ID of an account mapped to your app, in the same mode as your key.`]})]}),_jsxs(Accordion,{title:`The earlier request is still being processed.`,id:`the-earlier-request-is-still-being-processed`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`409`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`idempotency_in_progress`})]}),_jsxs(_components.p,{children:[`An upload with this `,_jsx(_components.code,{children:`X-Idempotency-Key`}),` is still running.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Wait for the time in the `,_jsx(_components.code,{children:`Retry-After`}),` header, then retry with the same key.`]})]}),_jsxs(Accordion,{title:`The file is too large.`,id:`the-file-is-too-large`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`413`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`file_too_large`})]}),_jsx(_components.p,{children:`The file is larger than 20 MB.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Upload a file of 20 MB or less. `,_jsx(_components.code,{children:`metadata.max_bytes`}),` is the limit in bytes.`]})]}),_jsxs(Accordion,{title:`The file format is not accepted for this document type.`,id:`the-file-format-is-not-accepted-for-this-document-type`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`415`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`unsupported_media_type`})]}),_jsx(_components.p,{children:`The request has one of these problems:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The body is not `,_jsx(_components.code,{children:`multipart/form-data`}),`. `,_jsx(_components.code,{children:`error.field`}),` is `,_jsx(_components.code,{children:`Content-Type`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The file format is not accepted for this document type. `,_jsx(_components.code,{children:`error.field`}),` is `,_jsx(_components.code,{children:`file`}),`.`]}),`\n`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Send the body as `,_jsx(_components.code,{children:`multipart/form-data`}),`. For the file, use a format in `,_jsx(_components.code,{children:`metadata.accept`}),`. `,_jsx(_components.code,{children:`metadata.detected_type`}),` shows the format found.`]})]}),_jsxs(Accordion,{title:`Too many requests. Try again shortly.`,id:`too-many-requests-try-again-shortly`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`429`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`rate_limited`})]}),_jsx(_components.p,{children:`Your app sent more requests than its rate limit allows.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Wait for the time in the `,_jsx(_components.code,{children:`Retry-After`}),` header, then retry.`]})]}),_jsxs(Accordion,{title:`Something went wrong on our side. Try again.`,id:`something-went-wrong-on-our-side-try-again`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Code:`}),` `,_jsx(_components.code,{children:`500`})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Reason:`}),` `,_jsx(_components.code,{children:`internal_error`})]}),_jsx(_components.p,{children:`Something went wrong inside Razorpay.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Solution:`}),` Retry the request.`]})]})]})]})}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":"Upload a Document","description":"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.","api":"POST /v1/accounts/{account_id}/documents","href":"/api/partners/accounts/upload-document"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Path Parameters","slug":"path-parameters","depth":2,"children":[]},{"title":"Request Parameters","slug":"request-parameters","depth":2,"children":[]},{"title":"Response Parameters","slug":"response-parameters","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"Curl","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"5\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -X\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://api.razorpay.com/v1/accounts/acc_TcdGEzmfKQzEl1/documents\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-u \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">rzp_test_partner_[CLIENT_ID]:[CLIENT_SECRET]\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"X-Idempotency-Key: [UNIQUE_KEY]\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-F \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"type=aadhaar_front\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-F \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"file=@aadhaar-front.jpg\"\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Success","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"12\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"file_Qx7Lm2Kd9Tz4Ab\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"entity\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"document\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"aadhaar_front\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"metadata\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"source\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"upload\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"file_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"aadhaar-front.jpg\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"mime_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"image/jpeg\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"size_bytes\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">183422\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Failure","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"14\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"BAD_REQUEST_ERROR\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"The file format is not accepted for this document type.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"source\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"business\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"step\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"validation\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"reason\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"unsupported_media_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"field\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"file\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"metadata\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"detected_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"image/heic\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"accept\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"application/pdf,image/jpeg,image/png\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Upload a Document","path":"/v1/accounts/{account_id}/documents","servers":[{"url":"https://api.razorpay.com"}],"method":"post","request":{"security":[{"title":"Basic Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"basic","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{"X-Idempotency-Key":{"schema":[{"type":"string","description":"A unique key you generate for each upload, 16-64 printable ASCII characters long. A Universally Unique Identifier (UUID) works. Know more about idempotency .","required":true}]}},"cookie":{},"path":{"account_id":{"schema":[{"type":"string","description":"The unique identifier of the account, `acc_` -prefixed. For example, `acc_TcdGEzmfKQzEl1` .","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"file":[{"type":"file","description":"The file, sent with its file name. Exactly 1 file of up to 20 MB: Format: PDF, JPEG or PNG. Razorpay detects the format from the file content. `cancelled_cheque_video` takes a video instead: MP4, MOV, M4V, MKV, AVI, WMV, FLV or MPEG. PDF: Up to 20 pages, without a password. Image: Up to 50 megapixels. File name: Up to 255 bytes, with no path separator or control character.","required":true}],"type":[{"type":"string","description":"The document type of the file, sent once. The account’s `requirements` list the types each product needs. Know more about document types .","required":true}]}}],"examples":{"example":{"value":{"type":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"id":[{"type":"string","description":"Unique identifier for the file, `file_` followed by 14 letters or digits."}],"entity":[{"type":"string","description":"Always `document` ."}],"type":[{"type":"string","description":"The document type of the file. Know more about the document types ."}],"url":[{"type":"string","description":"A signed link to download the file. Set only by Fetch One Document with `include_signed_url=true` . Otherwise `null` . It is also `null` when Razorpay could not create the link."}],"metadata":[{"type":"object","properties":{},"description":"About the stored file."}],"metadata.source":[{"type":"string","description":"Where the file came from. Possible values: `upload` : You uploaded it. `ckyc` : Razorpay downloaded it from the CKYC record."}],"metadata.file_name":[{"type":"string","description":"The file name as you sent it."}],"metadata.mime_type":[{"type":"string","description":"The format Razorpay detected from the file content, such as `image/jpeg` . It can be `null` ."}],"metadata.size_bytes":[{"type":"integer","description":"File size in bytes. It can be `null` ."}]}}],"examples":{"example":{"value":{"id":"\u003cstring>","entity":"\u003cstring>","type":"\u003cstring>","url":"\u003cstring>","metadata":{},"metadata.source":"\u003cstring>","metadata.file_name":"\u003cstring>","metadata.mime_type":"\u003cstring>","metadata.size_bytes":123}}}}}},"deprecated":false}},"jsLinks":["/docs/_mintlify/custom/razorpay-881012b3/0d344dfa342029c2/country-switcher.js","/docs/_mintlify/custom/razorpay-881012b3/d04f2910efb9afc8/static/docs-home/script.js","/docs/_mintlify/custom/razorpay-881012b3/79016038e50e3e6a/ga4.js","/docs/_mintlify/custom/razorpay-881012b3/0ccbc66d726b02ea/static/nav-more.js","/docs/_mintlify/custom/razorpay-881012b3/a849ad0bd40c8fc9/hreflang.js"],"subdomain":"razorpay-881012b3","siteName":"Razorpay","title":"Upload a Document - Razorpay","navMaps":{"firstHrefInVersion":{"India":{"href":"/api/partners/accounts/upload-document","matchLevel":0},"Singapore":{"href":"/sg/home","matchLevel":4},"United States":{"href":"/us/home","matchLevel":4},"Malaysia":{"href":"/my/home","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T14:09:17.868Z","gitLastModified":"2026-11-18T14:09:03.000Z","originalFileLocation":"api/partners/accounts/upload-document.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=\"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Razorpay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_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=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Upload a Document - Razorpay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Razorpay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://razorpay.com/docs/api/partners/accounts/upload-document\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://razorpay-881012b3.mintlify.site/docs/_mintlify/api/og/v2?division=Documents\u0026amp;title=Upload+a+Document\u0026amp;description=Upload+a+KYC+document+for+a+sub-merchant+account+using+Razorpay+Accounts+API.\u0026amp;theme=a4f414a96152b37051aa45a2\u0026amp;signature=a4d6162ff811efde4a38b9495b1e61735cd15859b29cd663e0951fee09c99291\">\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=\"Upload a Document - Razorpay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://razorpay-881012b3.mintlify.site/docs/_mintlify/api/og/v2?division=Documents\u0026amp;title=Upload+a+Document\u0026amp;description=Upload+a+KYC+document+for+a+sub-merchant+account+using+Razorpay+Accounts+API.\u0026amp;theme=a4f414a96152b37051aa45a2\u0026amp;signature=a4d6162ff811efde4a38b9495b1e61735cd15859b29cd663e0951fee09c99291\">\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=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Razorpay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3395FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://razorpay.com/docs/api/partners/accounts/upload-document\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/partners/accounts/upload-document.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://razorpay.com/#organization\",\"name\":\"Razorpay\",\"url\":\"https://razorpay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/logo/light.svg?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=e0750375ee2004193a685f9f211963fe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://razorpay.com/docs#website\",\"name\":\"Razorpay\",\"url\":\"https://razorpay.com/docs\",\"publisher\":{\"@id\":\"https://razorpay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://razorpay.com/docs/api/partners/accounts/upload-document#webpage\",\"url\":\"https://razorpay.com/docs/api/partners/accounts/upload-document\",\"name\":\"Upload a Document\",\"description\":\"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.\",\"dateModified\":\"2026-11-18T14:09:03.000Z\",\"isPartOf\":{\"@id\":\"https://razorpay.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://razorpay.com/docs/api/partners/accounts/upload-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://razorpay.com/docs/api/partners/accounts/upload-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partners\",\"item\":\"https://razorpay.com/docs/api/partners\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Onboarding APIs\",\"item\":\"https://razorpay.com/docs/api/partners/accounts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Documents\",\"item\":\"https://razorpay.com/docs/api/partners/accounts/document-entity\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Upload a Document\",\"item\":\"https://razorpay.com/docs/api/partners/accounts/upload-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://razorpay.com/docs/api/partners/accounts/upload-document#apireference\",\"headline\":\"Upload a Document\",\"name\":\"Upload a Document\",\"description\":\"Upload a KYC document for a sub-merchant account using Razorpay Accounts API.\",\"url\":\"https://razorpay.com/docs/api/partners/accounts/upload-document\",\"mainEntityOfPage\":{\"@id\":\"https://razorpay.com/docs/api/partners/accounts/upload-document#webpage\"},\"dateModified\":\"2026-11-18T14:09:03.000Z\",\"publisher\":{\"@id\":\"https://razorpay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://razorpay.com/docs#website\"}}]}\u003c/script>","agentPointerHref":"/docs/api/partners/accounts/upload-document.md","siteName":"Razorpay","nav":{"global":null,"versions":[{"version":"India","default":true,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":"/home"}]},{"tab":"Payments","icon":"credit-card","pages":[{"title":"Payments","href":"/payments"}]},{"tab":"Engage","icon":"bullhorn","pages":[{"title":"Engage","href":"/engage"}]},{"tab":"POS","icon":"cash-register","pages":[{"title":"POS","href":"/pos"}]},{"tab":"Banking Plus","icon":"building-columns","pages":[{"title":"Banking Plus","href":"/x"}]},{"tab":"Payroll","icon":"money-check-dollar","pages":[{"title":"Payroll","href":"/payroll"}]},{"tab":"Partners","icon":"handshake","pages":[{"title":"Partners","href":"/partners"}]},{"tab":"API Reference","icon":"code","pages":[{"group":"Introduction","root":{"title":"API Reference Guide","href":"/api"},"pages":[{"title":"API Changelog","href":"/api/changelog"},{"title":"Understand Razorpay APIs","href":"/api/understand"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"API Sandbox Setup","sidebarTitle":"Sandbox Setup","href":"/api/sandbox-setup"},{"title":"Install the Razorpay CLI","sidebarTitle":"Install CLI","href":"/api/install-cli"},{"title":"Best Practices","href":"/api/best-practices"},{"title":"Glossary","href":"/api/glossary"}]},{"group":"Payments","root":{"title":"Payments","href":"/api/payments"},"pages":[{"group":"Orders","pages":[{"title":"Orders","href":"/api/orders"},{"title":"Orders Entity","href":"/api/orders/entity"},{"title":"Create an Order","api":"POST /v1/orders","href":"/api/orders/create"},{"title":"Fetch All Orders","api":"GET /v1/orders","href":"/api/orders/fetch-all"},{"title":"Fetch All Orders (With Expanded Payments)","api":"GET /v1/orders?expand[]=payments","href":"/api/orders/fetch-all-expanded-payments"},{"title":"Fetch All Orders (With Expand Card Payments)","api":"GET /v1/orders?expand[]=payments.card","href":"/api/orders/fetch-all-expanded-card-payments"},{"title":"Fetch an Order With ID","api":"GET /v1/orders/:id","href":"/api/orders/fetch-with-id"},{"title":"Fetch Payments for an Order","api":"GET /v1/orders/:id/payments","href":"/api/orders/fetch-payments"},{"title":"Update an Order","api":"PATCH /v1/orders/:id","href":"/api/orders/update"}]},{"group":"Payments","pages":[{"title":"Payments Entity","href":"/api/payments/entity"},{"title":"Capture a Payment","api":"POST /v1/payments/:id/capture","href":"/api/payments/capture"},{"title":"Fetch a Payment With ID","api":"GET /v1/payments/:id","href":"/api/payments/fetch-with-id"},{"title":"Fetch a Payment (With Expanded Card Details)","api":"GET /v1/payments/:id/?expand[]=card","href":"/api/payments/fetch-payment-expanded-card"},{"title":"Fetch a Payment with Expanded EMI Details","api":"GET /v1/payments/:id/?expand[]=emi","href":"/api/payments/fetch-payment-expanded-emi"},{"title":"Fetch a Payment with Expanded Offers Details","api":"GET /v1/payments/:id/?expand[]=offers","href":"/api/payments/fetch-payment-expanded-offers"},{"title":"Fetch All Payments","api":"GET /v1/payments","href":"/api/payments/fetch-all-payments"},{"title":"Fetch All Payments (With Expanded Card Details)","api":"GET /v1/payments?expand[]=card","href":"/api/payments/fetch-all-payments-with-expanded-card-details"},{"title":"Fetch All Payments (With Expanded EMI Details)","api":"GET /v1/payments?expand[]=emi","href":"/api/payments/fetch-all-payments-with-expanded-emi-details"},{"title":"Fetch Payments Based on Orders","api":"GET /v1/orders/:id/payments","href":"/api/payments/fetch-payments-orders"},{"title":"Fetch Card Details of a Payment","api":"GET /v1/payments/:id/card","href":"/api/payments/fetch-card-details-payment"},{"title":"Update a Payment","api":"PATCH /v1/payments/:id/","href":"/api/payments/update"}]},{"group":"Downtime","pages":[{"title":"Payment Downtime","sidebarTitle":"Downtime","href":"/api/payments/downtime"},{"title":"Payment Downtime Entity","href":"/api/payments/downtime/entity"},{"title":"Fetch All Payment Downtime Details","api":"GET /v1/payments/downtimes","href":"/api/payments/downtime/fetch-all"},{"title":"Fetch Payment Downtime Details With ID","api":"GET /v1/payments/downtimes/:id","href":"/api/payments/downtime/fetch-with-id"}]},{"group":"Settlements","pages":[{"title":"Settlements","href":"/api/settlements"},{"title":"Settlements Entity","href":"/api/settlements/entity"},{"title":"Fetch All Settlements","api":"GET /v1/settlements/","href":"/api/settlements/fetch-all"},{"title":"Fetch Settlements With ID","api":"GET /v1/settlements/:id","href":"/api/settlements/fetch-with-id"},{"title":"Fetch Settlement Recon Details","api":"GET /v1/settlements/recon/combined?year=yyyy\u0026month=mm","href":"/api/settlements/fetch-recon"}]},{"group":"Instant Settlements","pages":[{"title":"Instant Settlements","href":"/api/settlements/instant"},{"title":"Instant Settlements Entity","href":"/api/settlements/instant/entity"},{"title":"Create an Instant Settlement","api":"POST /v1/settlements/ondemand","href":"/api/settlements/instant/create"},{"title":"Fetch All Instant Settlements","api":"GET /v1/settlements/ondemand","href":"/api/settlements/instant/fetch-all"},{"title":"Fetch Instant Settlement With ID","api":"GET /v1/settlements/ondemand/:id","href":"/api/settlements/instant/fetch-with-id"},{"title":"Fetch All Instant Settlements With Payout Details","api":"GET /v1/settlements/ondemand/?expand[]=ondemand_payouts","href":"/api/settlements/instant/fetch-all-payout"},{"title":"Fetch Instant Settlement With ID and Payout Details","api":"GET /v1/settlements/ondemand/:id?expand[]=ondemand_payouts","href":"/api/settlements/instant/fetch-with-id-payout"}]},{"group":"Refunds","pages":[{"title":"Refunds","href":"/api/refunds"},{"title":"Refunds Entity","href":"/api/refunds/entity"},{"title":"Create a Normal Refund","api":"POST /v1/payments/:id/refund","href":"/api/refunds/create-normal"},{"title":"Create an Instant Refund","api":"POST /v1/payments/:id/refund","href":"/api/refunds/create-instant"},{"title":"Fetch Multiple Refunds for a Payment","api":"GET /v1/payments/:id/refunds","href":"/api/refunds/fetch-multiple-refund-payment"},{"title":"Fetch a Specific Refund for a Payment","api":"GET /v1/payments/:payment_id/refunds/:refund_id","href":"/api/refunds/fetch-specific-refund-payment"},{"title":"Fetch All Refunds","api":"GET /v1/refunds/","href":"/api/refunds/fetch-all"},{"title":"Fetch Refund With ID","api":"GET /v1/refunds/:id","href":"/api/refunds/fetch-with-id"},{"title":"Update a Refund","api":"PATCH /v1/refunds/:id/","href":"/api/refunds/update"}]},{"group":"Disputes","pages":[{"title":"Disputes","href":"/api/disputes"},{"title":"Disputes Entity","href":"/api/disputes/entity"},{"title":"Fetch All Disputes","api":"GET /v1/disputes","href":"/api/disputes/fetch-all"},{"title":"Fetch a Dispute With ID","api":"GET /v1/disputes/:id","href":"/api/disputes/fetch"},{"title":"Fetch a Dispute With ID (With Expanded Payments Details)","api":"GET /v1/disputes/:id?expand[]=payment","href":"/api/disputes/fetch-dispute-expanded-payment"},{"title":"Fetch a Dispute With ID (With Expanded transaction.settlement Details)","api":"GET /v1/disputes/:id?expand[]=transaction.settlement","href":"/api/disputes/fetch-dispute-expanded-transaction"},{"title":"Accept a Dispute","api":"POST /v1/disputes/:id/accept","href":"/api/disputes/accept"},{"title":"Contest a Dispute","api":"PATCH /v1/disputes/:id/contest","href":"/api/disputes/contest"}]},{"group":"Documents","pages":[{"title":"Documents","href":"/api/documents"},{"title":"Documents Entity","href":"/api/documents/entity"},{"title":"Create a Document","api":"POST /v1/documents","href":"/api/documents/create"},{"title":"Fetch Document Information","api":"GET /v1/documents/:id","href":"/api/documents/fetch-info"},{"title":"Fetch Document Content","api":"GET /v1/documents/:id/content","href":"/api/documents/fetch-content"}]},{"group":"Customers","pages":[{"title":"Customers","href":"/api/customers"},{"title":"Customers Entity","href":"/api/customers/entity"},{"title":"Create a Customer","api":"POST /v1/customers","href":"/api/customers/create"},{"title":"Edit Customer Details","api":"PUT /v1/customers/:id","href":"/api/customers/edit"},{"title":"Fetch All Customers","api":"GET /v1/customers","href":"/api/customers/fetch-all"},{"title":"Fetch Customer With ID","api":"GET /v1/customers/:id","href":"/api/customers/fetch-with-id"}]},{"group":"Payment Links","pages":[{"title":"Payment Links","href":"/api/payments/payment-links"},{"title":"Payment Links Entity","href":"/api/payments/payment-links/entity"},{"title":"Create a Standard Payment Link","api":"POST /v1/payment_links","href":"/api/payments/payment-links/create-standard"},{"title":"Create a UPI Payment Link","api":"POST /v1/payment_links","href":"/api/payments/payment-links/create-upi"},{"title":"Fetch All Standard Payment Links","api":"GET /v1/payment_links/","href":"/api/payments/payment-links/fetch-all-standard"},{"title":"Fetch All UPI Payment Links","api":"GET /v1/payment_links/","href":"/api/payments/payment-links/fetch-all-upi"},{"title":"Fetch Standard Payment Links With ID","api":"GET /v1/payment_links/:id","href":"/api/payments/payment-links/fetch-id-standard"},{"title":"Fetch UPI Payment Links With ID","api":"GET /v1/payment_links/:id","href":"/api/payments/payment-links/fetch-id-upi"},{"title":"Send or Resend Notifications","api":"POST /v1/payment_links/:id/notify_by/:medium","href":"/api/payments/payment-links/resend"},{"title":"Update Standard Payment Link","api":"PATCH /v1/payment_links/:id","href":"/api/payments/payment-links/update-standard"},{"title":"Update UPI Payment Link","api":"PATCH /v1/payment_links/:id","href":"/api/payments/payment-links/update-upi"},{"title":"Cancel a Standard Payment Link","api":"POST /v1/payment_links/:id/cancel","href":"/api/payments/payment-links/cancel-standard"},{"title":"Cancel a UPI Payment Link","api":"POST /v1/payment_links/:id/cancel","href":"/api/payments/payment-links/cancel-upi"},{"title":"Implement Thematic Changes in Payment Links Checkout Section","api":"POST /v1/payment_links","href":"/api/payments/payment-links/checkout-theme"},{"title":"Change Business Name","api":"POST /v1/payment_links","href":"/api/payments/payment-links/change-business-name"},{"title":"Customise Payment Methods - Options and Method Parameters","api":"POST /v1/payment_links","href":"/api/payments/payment-links/customise-payment-methods"},{"title":"Customise Payment Methods - Options and Config Parameters","api":"POST /v1/payment_links","href":"/api/payments/payment-links/customise-options-config"},{"title":"Rename Labels in Checkout Section","api":"POST /v1/payment_links","href":"/api/payments/payment-links/rename-checkout-labels"},{"title":"Rename Labels in Payment Details Section","api":"POST /v1/payment_links","href":"/api/payments/payment-links/rename-payment-details-labels"},{"title":"Offers on Payment Links","api":"POST /v1/payment_links","href":"/api/payments/payment-links/offers"},{"title":"Transfer Payments Received Using Payment Links","api":"POST /v1/payment_links","href":"/api/payments/payment-links/transfer-payments"},{"title":"Perform Third-Party Validation Using Payment Links","api":"POST /v1/payment_links","href":"/api/payments/payment-links/third-party-validation"}]},{"group":"QR Codes","pages":[{"title":"QR Codes","href":"/api/qr-codes"},{"title":"QR Codes Entity","href":"/api/qr-codes/entity"},{"title":"Create a QR Code","api":"POST /v1/payments/qr_codes","href":"/api/qr-codes/create"},{"title":"Close a QR Code","api":"POST /v1/payments/qr_codes/:id/close","href":"/api/qr-codes/close"},{"title":"Fetch All QR Codes","api":"GET /v1/payments/qr_codes?count=2","href":"/api/qr-codes/fetch-all"},{"title":"Fetch a QR Code","api":"GET /v1/payments/qr_codes/:id","href":"/api/qr-codes/fetch-with-id"},{"title":"Fetch QR Codes for a Customer ID","api":"GET /v1/payments/qr_codes?customer_id=\\{customer_id\\}","href":"/api/qr-codes/fetch-customer-id"},{"title":"Fetch QR Codes for a Payment ID","api":"GET /v1/payments/qr_codes?payment_id=\\{payment_id\\}","href":"/api/qr-codes/fetch-payment-id"},{"title":"Fetch Payments for a QR Code","api":"GET /v1/payments/qr_codes/:id/payments","href":"/api/qr-codes/fetch-payments"},{"title":"Update a QR Code","api":"PATCH /v1/payments/qr_codes/:id/","href":"/api/qr-codes/update"}]},{"group":"Invoices","pages":[{"title":"Invoices","href":"/api/payments/invoices"},{"title":"Invoices Entity","href":"/api/payments/invoices/entity"},{"title":"Create an Invoice With Customer ID","api":"POST /v1/invoices","href":"/api/payments/invoices/create-with-customer-id"},{"title":"Create an Invoice With Customer Details","api":"POST /v1/invoices","href":"/api/payments/invoices/create-with-details"},{"title":"Update an Invoice","api":"PATCH /v1/invoices/:id","href":"/api/payments/invoices/update"},{"title":"Issue an Invoice","api":"POST /v1/invoices/:id/issue","href":"/api/payments/invoices/issue"},{"title":"Delete an Invoice","api":"DELETE /v1/invoices/:id","href":"/api/payments/invoices/delete"},{"title":"Cancel an Invoice","api":"POST /v1/invoices/:id/cancel","href":"/api/payments/invoices/cancel"},{"title":"Fetch an Invoice With ID","api":"GET /v1/invoices/:id","href":"/api/payments/invoices/fetch-with-id"},{"title":"Fetch All Invoices","api":"GET /v1/invoices","href":"/api/payments/invoices/fetch-all"},{"title":"Send Notifications","api":"POST /v1/invoices/:id/notify_by/:medium","href":"/api/payments/invoices/resend"},{"title":"Items Entity","href":"/api/payments/invoices/item-entity"},{"title":"Create an Item","api":"POST /v1/items","href":"/api/payments/invoices/create-item"},{"title":"Fetch Item With ID","api":"GET /v1/items/:id","href":"/api/payments/invoices/fetch-with-id-item"},{"title":"Fetch All Items","api":"GET /v1/items","href":"/api/payments/invoices/fetch-all-items"},{"title":"Update an Item","api":"PATCH /v1/items/:id","href":"/api/payments/invoices/update-item"},{"title":"Delete an Item","api":"DELETE /v1/items/:id","href":"/api/payments/invoices/delete-item"}]},{"group":"Subscriptions","pages":[{"title":"Subscriptions","href":"/api/payments/subscriptions"},{"title":"Plans Entity","href":"/api/payments/subscriptions/plans-entity"},{"title":"Create a Plan","api":"POST /v1/plans","href":"/api/payments/subscriptions/create-plan"},{"title":"Fetch All Plans","api":"GET /v1/plans","href":"/api/payments/subscriptions/fetch-all-plans"},{"title":"Fetch a Plan With ID","api":"GET /v1/plans/:id","href":"/api/payments/subscriptions/fetch-a-plan"},{"title":"Subscriptions Entity","href":"/api/payments/subscriptions/entity"},{"title":"Create a Subscription","api":"POST /v1/subscriptions","href":"/api/payments/subscriptions/create-subscription"},{"title":"Create a Subscription Link","api":"POST /v1/subscriptions","href":"/api/payments/subscriptions/create-subscription-link"},{"title":"Fetch All Subscriptions","api":"GET /v1/subscriptions","href":"/api/payments/subscriptions/fetch-subscriptions"},{"title":"Fetch a Subscription With ID","api":"GET /v1/subscriptions/:id","href":"/api/payments/subscriptions/fetch-subscription-id"},{"title":"Cancel a Subscription","api":"POST /v1/subscriptions/:id/cancel","href":"/api/payments/subscriptions/cancel-subscription"},{"title":"Update a Subscription","api":"PATCH /v1/subscriptions/:id","href":"/api/payments/subscriptions/update-subscription"},{"title":"Fetch Details of a Pending Update","api":"GET /v1/subscriptions/:id/retrieve_scheduled_changes","href":"/api/payments/subscriptions/fetch-pending-update-details"},{"title":"Cancel an Update","api":"POST /v1/subscriptions/:id/cancel_scheduled_changes","href":"/api/payments/subscriptions/cancel-update"},{"title":"Pause a Subscription","api":"POST /v1/subscriptions/:id/pause","href":"/api/payments/subscriptions/pause-subscription"},{"title":"Resume a Subscription","api":"POST /v1/subscriptions/:id/resume","href":"/api/payments/subscriptions/resume-subscription"},{"title":"Fetch All Invoices of a Subscription","api":"GET /v1/invoices?subscription_id=:sub_id","href":"/api/payments/subscriptions/fetch-invoices"},{"title":"Link an Offer to a Subscription","api":"POST /v1/subscriptions","href":"/api/payments/subscriptions/link-offer"},{"title":"Delete an Offer Linked to a Subscription","api":"DELETE /v1/subscriptions/:sub_id/:offer_id","href":"/api/payments/subscriptions/delete-offer"}]},{"group":"Recurring Payments","root":{"title":"Recurring Payments API","sidebarTitle":"Recurring Payments","href":"/api/payments/recurring-payments"},"pages":[{"title":"Postman Collection","href":"/api/payments/recurring-payments/postman-collection"},{"group":"Emandate","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/emandate/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/emandate/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/emandate/create-subsequent-payments"}]},{"group":"Cards","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/cards/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/cards/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/cards/create-subsequent-payments"}]},{"group":"Wallets","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/wallets/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/wallets/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/wallets/create-subsequent-payments"}]},{"group":"Paper NACH","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/paper-nach/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/paper-nach/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/paper-nach/create-subsequent-payments"}]},{"group":"UPI Autopay","pages":[{"group":"UPI","pages":[{"title":"1. Create an Authorisation Transaction","href":"/api/payments/recurring-payments/upi/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/upi/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/upi/create-subsequent-payments"}]},{"group":"UPI with TPV","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/upi-tpv/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/upi-tpv/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/upi-tpv/create-subsequent-payments"}]},{"group":"UPI One Time Mandate","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/upi-otm/authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/upi-otm/tokens"},{"title":"3. Create a One Time Payment","href":"/api/payments/recurring-payments/upi-otm/one-time-payment"},{"title":"Frequently Asked Questions (FAQs)","href":"/api/payments/recurring-payments/upi-otm/faqs"}]},{"group":"UPI Reserve Pay (SBMD)","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/upi-reserve-pay/authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/upi-reserve-pay/tokens"},{"title":"3. Create a One Time Payment","href":"/api/payments/recurring-payments/upi-reserve-pay/one-time-payment"}]}]},{"group":"Registration and Charge First Payment Together","pages":[{"title":"Charge First Payment Automatically after Emandate Registration","sidebarTitle":"Emandate","href":"/api/payments/recurring-payments/emandate/auto-debit"},{"title":"Charge First Payment Automatically after NACH Registration","sidebarTitle":"Paper NACH","href":"/api/payments/recurring-payments/paper-nach/auto-debit"}]},{"title":"Webhooks","href":"/api/payments/recurring-payments/webhooks"},{"group":"Custom Integration","root":{"title":"Recurring Payments API - Custom Integration","href":"/api/payments/recurring-payments/custom"},"pages":[{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/api/payments/recurring-payments/custom/postman-collection"},{"group":"UPI Autopay","pages":[{"group":"UPI","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/custom/upi/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/custom/upi/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/custom/upi/create-subsequent-payments"}]},{"group":"UPI with TPV","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/custom/upi-tpv/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/custom/upi-tpv/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/custom/upi-tpv/create-subsequent-payments"}]},{"group":"UPI One Time Mandate","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/custom/upi-otm/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/custom/upi-otm/tokens"},{"title":"3. Create a One Time Payment","href":"/api/payments/recurring-payments/custom/upi-otm/one-time-payment"}]},{"group":"UPI Reserve Pay (SBMD)","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/custom/upi-reserve-pay/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/custom/upi-reserve-pay/tokens"},{"title":"3. Create a One Time Payment","href":"/api/payments/recurring-payments/custom/upi-reserve-pay/one-time-payment"}]}]},{"group":"Cards","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/custom/cards/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/custom/cards/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/custom/cards/create-subsequent-payments"}]},{"group":"Emandate","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/custom/emandate/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/custom/emandate/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/custom/emandate/create-subsequent-payments"}]},{"group":"Paper NACH","pages":[{"title":"1. Create the Authorisation Transaction","href":"/api/payments/recurring-payments/custom/paper-nach/create-authorization-transaction"},{"title":"2. Fetch and Manage Tokens","href":"/api/payments/recurring-payments/custom/paper-nach/tokens"},{"title":"3. Create Subsequent Payments","href":"/api/payments/recurring-payments/custom/paper-nach/create-subsequent-payments"}]},{"group":"Registration and Charge First Payment Together","pages":[{"title":"Charge First Payment Automatically after Emandate Registration","sidebarTitle":"Emandate","href":"/api/payments/recurring-payments/custom/emandate/auto-debit"},{"title":"Charge First Payment Automatically after NACH Registration","sidebarTitle":"Paper NACH","href":"/api/payments/recurring-payments/custom/paper-nach/auto-debit"}]},{"title":"Webhooks","href":"/api/payments/recurring-payments/custom/webhooks"}]}]},{"group":"Route","pages":[{"title":"Route","href":"/api/payments/route"},{"title":"Linked Account Entity","href":"/api/payments/route/linked-account-entity"},{"title":"Create a Linked Account","api":"POST /v2/accounts","href":"/api/payments/route/create-linked-account"},{"title":"Create a Linked Account (Composite)","api":"POST /v2/accounts","href":"/api/payments/route/create-linked-account-composite"},{"title":"Update a Linked Account","api":"PATCH /v2/accounts/:account_id","href":"/api/payments/route/update-linked-accounts"},{"title":"Fetch a Linked Account With ID","api":"GET /v2/accounts/:account_id","href":"/api/payments/route/fetch-with-id"},{"title":"Stakeholder Entity","href":"/api/payments/route/stakeholder-entity"},{"title":"Create a Stakeholder Account","api":"POST /v2/accounts/:account_id/stakeholders","href":"/api/payments/route/create-stakeholder"},{"title":"Update a Stakeholder Account","api":"PATCH /v2/accounts/:account_id/stakeholders/:stakeholder_id","href":"/api/payments/route/update-stakeholder"},{"title":"Product Configuration Entity","href":"/api/payments/route/product-configuration-entity"},{"title":"Request a Product Configuration","api":"POST /v2/accounts/:account_id/products","href":"/api/payments/route/request-product-config"},{"title":"Update a Product Configuration","api":"PATCH /v2/accounts/:account_id/products/:product_id","href":"/api/payments/route/update-product-config"},{"title":"Fetch a Product Configuration","api":"GET /v2/accounts/:account_id/products/:product_id","href":"/api/payments/route/fetch-product-config"},{"title":"Transfers Entity","href":"/api/payments/route/transfers-entity"},{"title":"Create Transfers From Orders","api":"POST /v1/orders","href":"/api/payments/route/create-transfers-orders"},{"title":"Create Transfers From Payments","api":"POST /v1/payments/:id/transfers","href":"/api/payments/route/create-transfers-payments"},{"title":"Create a Direct Transfer","api":"POST /v1/transfers","href":"/api/payments/route/direct-transfers"},{"title":"Create a Direct Transfer (Idempotent Request)","api":"POST /v1/transfers","href":"/api/payments/route/direct-transfers-idempotent-request"},{"title":"Fetch Transfers for a Payment","api":"GET /v1/payments/:id/transfers","href":"/api/payments/route/fetch-transfers-payment"},{"title":"Fetch Transfer for an Order","api":"GET /v1/orders/:id/?expand[]=transfers\u0026status=processing","href":"/api/payments/route/fetch-transfer-order"},{"title":"Fetch a Transfer With ID","api":"GET /v1/transfers/:id","href":"/api/payments/route/fetch-a-transfer"},{"title":"Fetch Transfers for a Settlement","api":"GET /v1/transfers?recipient_settlement_id=:id","href":"/api/payments/route/fetch-transfers-for-a-settlement"},{"title":"Fetch Settlement Details","api":"GET /v1/transfers?expand[]=recipient_settlement","href":"/api/payments/route/fetch-settlement-details"},{"title":"Fetch Payments of a Linked Account","api":"GET /v1/payments/","href":"/api/payments/route/fetch-payments-linked-account"},{"title":"Refund Payments and Reverse Transfer from a Linked Account","api":"POST /v1/payments/:id/refund","href":"/api/payments/route/refund-payments-and-reverse-transfer"},{"title":"Reverse a Transfer","api":"POST /v1/transfers/:id/reversals","href":"/api/payments/route/reverse-a-transfer"},{"title":"Fetch Reversals for a Transfer","api":"GET /v1/transfers/:id/reversals","href":"/api/payments/route/fetch-reversals"},{"title":"Modify Settlement Hold for Transfers","api":"PATCH /v1/transfers/:id","href":"/api/payments/route/modify-settlement-hold"}]},{"group":"Smart Collect","pages":[{"title":"Smart Collect","href":"/api/payments/smart-collect"},{"title":"Smart Collect Entity","href":"/api/payments/smart-collect/entity"},{"title":"Create a Customer Identifier With Bank Account Receiver","api":"POST /v1/virtual_accounts","href":"/api/payments/smart-collect/create-cust-id-bank-account"},{"title":"Close a Customer Identifier","api":"POST /v1/virtual_accounts/:id/close","href":"/api/payments/smart-collect/close"},{"title":"Fetch a Customer Identifier Using id","api":"GET /v1/virtual_accounts/:id","href":"/api/payments/smart-collect/fetch-with-id"},{"title":"Fetch All Customer Identifiers","api":"GET /v1/virtual_accounts","href":"/api/payments/smart-collect/fetch-all"},{"title":"Fetch Payments for a Customer Identifier","api":"GET /v1/virtual_accounts/:id/payments","href":"/api/payments/smart-collect/fetch-payments-cust-id"},{"title":"Fetch Payments Made Using Bank Transfer","api":"GET /v1/payments/:id/bank_transfer","href":"/api/payments/smart-collect/fetch-payments-bank-transfer"},{"title":"Fetch Payments Using UTR Number","api":"GET /v1/payments?skip=0\u0026count=25\u0026va_transaction_id=:id\u0026virtual_account=1","href":"/api/payments/smart-collect/fetch-payments-bank-transfer-utr"},{"title":"Update a Customer Identifier","api":"PATCH /v1/virtual_accounts/:id","href":"/api/payments/smart-collect/update"},{"title":"Smart Collect With TPV","sidebarTitle":"Smart Collect TPV","href":"/api/payments/smart-collect-tpv"},{"title":"Smart Collect With TPV Entity","href":"/api/payments/smart-collect-tpv/entity"},{"title":"Create a Customer Identifier With TPV","api":"POST /v1/virtual_accounts","href":"/api/payments/smart-collect-tpv/create"},{"title":"Add an Allowed Payer Account","api":"POST /v1/virtual_accounts/:va_id/allowed_payers","href":"/api/payments/smart-collect-tpv/add-allowed-payer"},{"title":"Fetch a Customer Identifier Using id With TPV","api":"GET /v1/virtual_accounts/:id","href":"/api/payments/smart-collect-tpv/fetch-with-id"},{"title":"Fetch All Customer Identifiers With TPV","api":"GET /v1/virtual_accounts","href":"/api/payments/smart-collect-tpv/fetch-all"},{"title":"Fetch Payments for a Customer Identifier With TPV","api":"GET /v1/virtual_accounts/:id/payments","href":"/api/payments/smart-collect-tpv/fetch-payments"},{"title":"Fetch Payment Details using ID and Transfer Method","api":"GET /v1/payments/:id/bank_transfer","href":"/api/payments/smart-collect-tpv/fetch-payment-id-transfer"},{"title":"Delete an Allowed Payer Account","api":"DELETE /v1/virtual_accounts/:va_id/allowed_payers/:id","href":"/api/payments/smart-collect-tpv/delete-allowed-payer"},{"title":"Smart Collect 2.0 APIs","sidebarTitle":"Smart Collect 2.0","href":"/api/payments/smart-collect-2"},{"title":"Smart Collect 2.0 Entity","href":"/api/payments/smart-collect-2/entity"},{"title":"Create a Customer Identifier With VPA and Bank Account Receivers With Smart Collect 2.0","api":"POST /v1/virtual_accounts","href":"/api/payments/smart-collect-2/create-cust-id-bank-account-vpa"},{"title":"Add VPA Receiver to an Existing Customer Identifier","api":"POST /v1/virtual_accounts/:id/receivers","href":"/api/payments/smart-collect-2/add-receiver-vpa"},{"title":"Fetch Payments Made Using UPI Payment Method","api":"GET /v1/payments/:id/upi_transfer","href":"/api/payments/smart-collect-2/fetch-payments-upi"}]}]},{"group":"Bills","root":{"title":"About Bills","href":"/api/bills"},"pages":[{"title":"Bills Entity","href":"/api/bills/entity"},{"title":"Create a Bill","api":"POST /v1/bills","href":"/api/bills/create"},{"title":"Update a Bill","api":"PATCH /v1/bills/:bill_id","href":"/api/bills/update"},{"title":"Delete a Bill","api":"DELETE /v1/bills/:bill_id","href":"/api/bills/delete"}]},{"group":"Partners","root":{"title":"Partner APIs","href":"/api/partners"},"pages":[{"group":"Onboarding APIs","root":{"title":"Accounts API","href":"/api/partners/accounts"},"pages":[{"group":"Accounts","pages":[{"title":"Account Entity","href":"/api/partners/accounts/entity"},{"title":"Create an Account","api":"POST /v1/accounts","href":"/api/partners/accounts/create"},{"title":"Fetch Accounts","api":"GET /v1/accounts","href":"/api/partners/accounts/fetch"},{"title":"Update an Account","api":"PATCH /v1/accounts/{account_id}","href":"/api/partners/accounts/update"}]},{"group":"Actions","pages":[{"title":"Run an Action","api":"POST /v1/accounts/{account_id}/actions/{action}","href":"/api/partners/accounts/run-action"}]},{"group":"Requirements","pages":[{"title":"Requirement Entity","href":"/api/partners/accounts/requirement-entity"},{"title":"Business Model Questions","href":"/api/partners/accounts/business-model-questions"},{"title":"Business Categories","href":"/api/partners/accounts/business-categories"}]},{"group":"Documents","pages":[{"title":"Document Entity","description":"Know about document entity parameters and their description.","href":"/api/partners/accounts/document-entity"},{"title":"Upload a Document","api":"POST /v1/accounts/{account_id}/documents","href":"/api/partners/accounts/upload-document"},{"title":"Fetch All Documents","description":"Fetch all KYC documents of a sub-merchant account using Razorpay Accounts API.","api":"GET /v1/accounts/{account_id}/documents","href":"/api/partners/accounts/fetch-all-documents"},{"title":"Fetch One Document by ID","api":"GET /v1/accounts/{account_id}/documents/{file_id}","href":"/api/partners/accounts/fetch-document"},{"title":"Delete a Document","api":"DELETE /v1/accounts/{account_id}/documents/{file_id}","href":"/api/partners/accounts/delete-document"}]},{"title":"Errors","href":"/api/partners/accounts/errors"}]}]},{"group":"Payouts","root":{"title":"Get Started","href":"/api/x"},"pages":[{"group":"Account Validation","pages":[{"title":"Account Validation","href":"/api/x/account-validation"},{"title":"Account Validation Entity","href":"/api/x/account-validation/entity"},{"title":"Create a Contact","api":"POST /v1/contacts","href":"/api/x/account-validation/create-contact"},{"title":"Create a Fund Account of Type Bank Account","api":"POST /v1/fund_accounts","href":"/api/x/account-validation/bank-account/create-fund-account"},{"title":"Validate a Bank Account","api":"POST /v1/fund_accounts/validations","href":"/api/x/account-validation/bank-account"},{"title":"Create a Fund Account of Type VPA","api":"POST /v1/fund_accounts","href":"/api/x/account-validation/vpa/create-fund-account"},{"title":"Validate a VPA","api":"POST /v1/fund_accounts/validations","href":"/api/x/account-validation/vpa"},{"title":"Validate Bank Account (VPA) via Reverse Penny Drop","api":"POST /v1/fund_accounts/validations","href":"/api/x/account-validation/reverse-penny-drop"},{"title":"Fetch All Account Validation Transactions","api":"GET /v1/fund_accounts/validations?account_number=:account_number","href":"/api/x/account-validation/fetch-all-transactions"},{"title":"Fetch Account Validation Transaction With ID","api":"GET /v1/fund_accounts/validations/:id","href":"/api/x/account-validation/fetch-transactions-with-id"}]},{"group":"Composite Account Validation","pages":[{"title":"Account Validation Composite","sidebarTitle":"Composite Account Validation","href":"/api/x/composite-account-validation"},{"title":"Validate a Bank Account","api":"POST /v1/fund_accounts/validations","href":"/api/x/composite-account-validation/bank-account"},{"title":"Validate a VPA","api":"POST /v1/fund_accounts/validations","href":"/api/x/composite-account-validation/vpa"},{"title":"Fetch All Account Validation Transactions","api":"GET /v1/fund_accounts/validations?account_number=:account_number","href":"/api/x/composite-account-validation/fetch-all-transactions"},{"title":"Fetch Account Validation Transaction With ID","api":"GET /v1/fund_accounts/validations/:id","href":"/api/x/composite-account-validation/fetch-transactions-with-id"}]},{"group":"Contacts","pages":[{"title":"Contacts","href":"/api/x/contacts"},{"title":"Contacts Entity","href":"/api/x/contacts/entity"},{"title":"Create a Contact","api":"POST /v1/contacts","href":"/api/x/contacts/create"},{"title":"Update a Contact","api":"PATCH /v1/contacts/:id","href":"/api/x/contacts/update"},{"title":"Fetch All Contacts","api":"GET /v1/contacts","href":"/api/x/contacts/fetch-all"},{"title":"Fetch Contact With ID","api":"GET /v1/contacts/:id","href":"/api/x/contacts/fetch-with-id"},{"title":"Activate or Deactivate a Contact","api":"PATCH /v1/contacts/:id","href":"/api/x/contacts/activate-or-deactivate"}]},{"group":"Fund Accounts","pages":[{"title":"Fund Accounts","href":"/api/x/fund-accounts"},{"title":"Fund Accounts Entity","href":"/api/x/fund-accounts/entity"},{"title":"Create a Fund Account of Type Bank Account","api":"POST /v1/fund_accounts","href":"/api/x/fund-accounts/create/bank-account"},{"title":"Create a Fund Account of Type VPA","api":"POST /v1/fund_accounts","href":"/api/x/fund-accounts/create/vpa"},{"title":"Fetch All Fund Accounts","api":"GET /v1/fund_accounts","href":"/api/x/fund-accounts/fetch-all"},{"title":"Fetch a Fund Account With ID","api":"GET /v1/fund_accounts/:id","href":"/api/x/fund-accounts/fetch-with-id"},{"title":"Activate or Deactivate a Fund Account","api":"PATCH /v1/fund_accounts/:id","href":"/api/x/fund-accounts/activate-or-deactivate"}]},{"group":"Create and Manage Payouts","pages":[{"title":"Payouts","href":"/api/x/payouts"},{"title":"Payouts Entity","href":"/api/x/payouts/entity"},{"title":"Create a Payout to a Bank Account","api":"POST /v1/payouts","href":"/api/x/payouts/create/bank-account"},{"title":"Create a Payout to a VPA","api":"POST /v1/payouts","href":"/api/x/payouts/create/vpa"},{"title":"Fetch All Payouts","api":"GET /v1/payouts?account_number=:account_number","href":"/api/x/payouts/fetch-all"},{"title":"Fetch Payout With ID","api":"GET /v1/payouts/:id","href":"/api/x/payouts/fetch-with-id"},{"title":"Cancel a Queued Payout","api":"POST /v1/payouts/:id/cancel","href":"/api/x/payouts/cancel"}]},{"group":"Payouts to Cards","pages":[{"title":"Payouts to Cards","href":"/api/x/payouts-cards"},{"title":"Payouts to Cards Entity","href":"/api/x/payouts-cards/entity"},{"title":"Create a Payout Without Saving Card","api":"POST /v1/payouts","href":"/api/x/payouts-cards/create/without-saving-card"},{"title":"Create a Fund Account for Externally Tokenised Card","api":"POST /v1/fund_accounts","href":"/api/x/payouts-cards/create/save-card/external-token/fund-account"},{"title":"Create a Payout to Externally Tokenised Card","api":"POST /v1/payouts","href":"/api/x/payouts-cards/create/save-card/external-token/payout"},{"title":"Create a Fund Account for Card with Razorpay TokenHQ","api":"POST /v1/fund_accounts","href":"/api/x/payouts-cards/create/save-card/razorpay-tokenhq/fund-account"},{"title":"Create a Payout to Card with Razorpay TokenHQ","api":"POST /v1/payouts","href":"/api/x/payouts-cards/create/save-card/razorpay-tokenhq/payout"}]},{"group":"Payout Composite","pages":[{"title":"Payout Composite","href":"/api/x/payout-composite"},{"title":"Payout Composite Entity","href":"/api/x/payout-composite/entity"},{"title":"Create a Payout to Bank Account Using Composite API","api":"POST /v1/payouts","href":"/api/x/payout-composite/create/bank-account"},{"title":"Create a Payout to VPA Using Composite API","api":"POST /v1/payouts","href":"/api/x/payout-composite/create/vpa"},{"title":"Create a Payout to Card Using Composite API","api":"POST /v1/payouts","href":"/api/x/payout-composite/create/card"}]},{"group":"Payouts Approval","pages":[{"title":"Payouts Approval","href":"/api/x/payouts-approval"},{"title":"Payouts Approval Entity","href":"/api/x/payouts-approval/entity"},{"title":"Approve Payouts","api":"POST /v1/payouts/:id/approve","href":"/api/x/payouts-approval/approve"},{"title":"Reject Payouts","api":"POST /v1/payouts/:id/reject","href":"/api/x/payouts-approval/reject"}]},{"group":"Payout Idempotency","pages":[{"title":"Payout Idempotency","href":"/api/x/payout-idempotency"},{"title":"Make a Request Idempotent","api":"POST /v1/payouts","href":"/api/x/payout-idempotency/make-request"}]},{"group":"Payout Links","pages":[{"title":"Payout Links","href":"/api/x/payout-links"},{"title":"Payout Links Entity","href":"/api/x/payout-links/entity"},{"title":"Create Payout Links Using Contact Details","api":"POST /v1/payout-links","href":"/api/x/payout-links/create/use-contact-details"},{"title":"Create Payout Links Using Contact ID","api":"POST /v1/payout-links","href":"/api/x/payout-links/create/use-contact-id"},{"title":"Fetch All Payout Links","api":"GET /v1/payout-links","href":"/api/x/payout-links/fetch-all"},{"title":"Fetch a Payout Link With ID","api":"GET v1/payout-links/:id?expand[l=payouts","href":"/api/x/payout-links/fetch-with-id"},{"title":"Cancel a Payout Link","api":"POST /v1/payout-links/:id/cancel","href":"/api/x/payout-links/cancel"}]},{"group":"Payout Wallet - Amazon","pages":[{"title":"Payout Wallet - Amazon","href":"/api/x/payout-wallet"},{"title":"Payout Wallet - Amazon Entity","href":"/api/x/payout-wallet/entity"},{"title":"Create a Contact","api":"POST /v1/contacts/","href":"/api/x/payout-wallet/create/contact"},{"title":"Create a Fund Account of Type Wallet","api":"POST /v1/fund-accounts/","href":"/api/x/payout-wallet/create/fund-account"},{"title":"Create a Payout to Amazon Pay Wallet","api":"POST /v1/payouts","href":"/api/x/payout-wallet/create/payout"},{"title":"Make Payouts to Amazon Pay Wallet Using Composite API","api":"POST /v1/payouts","href":"/api/x/payout-wallet/create/payout-composite"}]},{"group":"Balance","pages":[{"title":"Fetch Balance","api":"GET /v1/banking_balances","href":"/api/x/account-validation/balance-fetch"}]},{"group":"Transactions","pages":[{"title":"Transactions","href":"/api/x/transactions"},{"title":"Transactions Entity","href":"/api/x/transactions/entity"},{"title":"Fetch All Transactions","api":"GET /v1/transactions?account_number=:account_number","href":"/api/x/transactions/fetch-all"},{"title":"Fetch Transactions With ID","api":"GET /v1/transactions/:id","href":"/api/x/transactions/fetch-with-id"}]}]}]},{"tab":"Developer Tools","icon":"screwdriver-wrench","pages":[{"title":"Developer Tools","href":"/developer-tools"}]},{"tab":"RBI Directive on Recurring Card Payments","hidden":true,"pages":[{"title":"RBI Directive on Recurring Card Payments","href":"/announcements/rbi-card-mandate-guidelines/recurring-payments"}]},{"tab":"RBI Directive on Card Payments for Subscriptions","hidden":true,"pages":[{"title":"RBI Directive on Card Payments for Subscriptions","href":"/announcements/rbi-card-mandate-guidelines/subscriptions"}]},{"tab":"Announcement Regarding TLS","hidden":true,"pages":[{"title":"Announcement Regarding TLS","href":"/announcements/tls"}]},{"tab":"Apple Pay S2S Flows","hidden":true,"pages":[{"title":"Apple Pay S2S Flows","href":"/payments/payment-methods/apple-pay/server-to-server/encrypted-token-flow"}]},{"tab":"Apple Pay S2S Integration","hidden":true,"pages":[{"title":"Apple Pay S2S Integration","href":"/payments/payment-methods/apple-pay/s2s-integration"}]},{"tab":"Bill Payments (BBPS)","hidden":true,"pages":[{"title":"Bill Payments (BBPS)","href":"/api/bills/bill-payments"}]},{"tab":"Products","hidden":true,"pages":[{"title":"Products","href":"/api/orders/products"}]},{"tab":"Card Fingerprints (or PAR) API","hidden":true,"pages":[{"title":"Card Fingerprints (or PAR) API","href":"/api/payments/cards/fingerprints"}]},{"tab":"Complaints","hidden":true,"pages":[{"title":"Complaints","href":"/api/payments/tpap-pro/complaints-flow"}]},{"tab":"Customer Onboarding","hidden":true,"pages":[{"title":"Customer Onboarding","href":"/api/payments/tpap-pro/customer-onboarding"}]},{"tab":"Accounts Management","hidden":true,"pages":[{"title":"Accounts Management","href":"/api/payments/tpap-pro/funds-account-management"}]},{"tab":"UPI Lite","hidden":true,"pages":[{"title":"UPI Lite","href":"/api/payments/tpap-pro/fundsource-lite"}]},{"tab":"Mandates","hidden":true,"pages":[{"title":"Mandates","href":"/api/payments/tpap-pro/mandate-flow"}]},{"tab":"Payments (API)","hidden":true,"pages":[{"title":"Payments (API)","href":"/api/payments/tpap-pro/payments-flow"}]},{"tab":"UPI Number","hidden":true,"pages":[{"title":"UPI Number","href":"/api/payments/tpap-pro/upi-number"}]},{"tab":"QR Codes GST APIs","hidden":true,"pages":[{"title":"QR Codes GST APIs","href":"/api/qr-codes/gst"}]},{"tab":"QR Codes (Image Content)","hidden":true,"pages":[{"title":"QR Codes (Image Content)","href":"/api/qr-codes/image-content"}]},{"tab":"Razorpay App Store - Discover App Integrations and Extensions","hidden":true,"pages":[{"title":"Razorpay App Store - Discover App Integrations and Extensions","href":"/app-store"}]},{"tab":"Razorpay POS Error Codes and Troubleshooting","hidden":true,"pages":[{"title":"Razorpay POS Error Codes and Troubleshooting","href":"/errors/pos"}]},{"tab":"About Aggregators","hidden":true,"pages":[{"title":"About Aggregators","href":"/partners/aggregators"}]},{"tab":"Merchant Risk","hidden":true,"pages":[{"title":"Merchant Risk","href":"/partners/aggregators/merchant-risk"}]},{"tab":"COD \u0026 Magic Checkout (formerly Checkout360)","hidden":true,"pages":[{"title":"COD \u0026 Magic Checkout (formerly Checkout360)","href":"/payments/cod-magic-checkout"}]},{"tab":"Configuration","hidden":true,"pages":[{"title":"Configuration","href":"/payments/dashboard/account-settings/configuration"}]},{"tab":"Dynamic Convenience Fees","hidden":true,"pages":[{"title":"Dynamic Convenience Fees","href":"/payments/dynamic-convenience-fees"}]},{"tab":"Integrate Razorpay Payment Button with Ghost CMS","hidden":true,"pages":[{"title":"Integrate Razorpay Payment Button with Ghost CMS","href":"/payments/ecommerce-plugins/ghost-integration"}]},{"tab":"About Insights","hidden":true,"pages":[{"title":"About Insights","href":"/payments/insights"}]},{"tab":"Integrate With Razorpay Import Flow - Custom Integration","hidden":true,"pages":[{"title":"Integrate With Razorpay Import Flow - Custom Integration","href":"/payments/international-payments/accept-international-payments-from-indian-customers/custom-integration"}]},{"tab":"About Razorpay Import Flow Web Standard Integration (Payments)","hidden":true,"pages":[{"title":"About Razorpay Import Flow Web Standard Integration (Payments)","href":"/payments/international-payments/accept-international-payments-from-indian-customers/import-flow/standard-integration"}]},{"tab":"Integrate With Razorpay Import Flow - S2S Integration","hidden":true,"pages":[{"title":"Integrate With Razorpay Import Flow - S2S Integration","href":"/payments/international-payments/accept-international-payments-from-indian-customers/s2s-integration"}]},{"tab":"About Razorpay Import Flow Web Standard Integration (International Payments)","hidden":true,"pages":[{"title":"About Razorpay Import Flow Web Standard Integration (International Payments)","href":"/payments/international-payments/accept-international-payments-from-indian-customers/standard-integration"}]},{"tab":"Outward Remittances for Education and Travel Payments","hidden":true,"pages":[{"title":"Outward Remittances for Education and Travel Payments","href":"/payments/international-payments/outward-remittances"}]},{"tab":"Risk Analytics Dashboard","hidden":true,"pages":[{"title":"Risk Analytics Dashboard","href":"/payments/international-payments/risk-visibility-dashboard"}]},{"tab":"Magic Checkout APIs","hidden":true,"pages":[{"title":"Magic Checkout APIs","href":"/payments/magic-checkout/apis"}]},{"tab":"RTO Intelligence","hidden":true,"pages":[{"title":"RTO Intelligence","href":"/payments/magic-checkout/rto-intelligence"}]},{"tab":"Integrate With Android Custom SDK","hidden":true,"pages":[{"title":"Integrate With Android Custom SDK","href":"/payments/payment-gateway/android-integration/custom"}]},{"tab":"Prerequisites (Payments)","hidden":true,"pages":[{"title":"Prerequisites (Payments)","href":"/payments/payment-gateway/ecommerce-plugins/shopify-razorpay-secure"}]},{"tab":"Eligibility Check API","hidden":true,"pages":[{"title":"Eligibility Check API","href":"/payments/payment-gateway/emi²/eligibility-check"}]},{"tab":"Integrate With Flutter Custom SDK","hidden":true,"pages":[{"title":"Integrate With Flutter Custom SDK","href":"/payments/payment-gateway/flutter-integration/custom"}]},{"tab":"Integrate With iOS Custom SDK","hidden":true,"pages":[{"title":"Integrate With iOS Custom SDK","href":"/payments/payment-gateway/ios-integration/custom"}]},{"tab":"Handle Payment Exceptions with Rainy Day Kit","hidden":true,"pages":[{"title":"Handle Payment Exceptions with Rainy Day Kit","href":"/payments/payment-gateway/rainy-day"}]},{"tab":"Integrate With React Native Custom SDK","hidden":true,"pages":[{"title":"Integrate With React Native Custom SDK","href":"/payments/payment-gateway/react-native-integration/custom"}]},{"tab":"Server-to-Server Integration","hidden":true,"pages":[{"title":"Server-to-Server Integration","href":"/payments/payment-gateway/s2s-integration"}]},{"tab":"Web Integration - Razorpay Custom Checkout","hidden":true,"pages":[{"title":"Web Integration - Razorpay Custom Checkout","href":"/payments/payment-gateway/web-integration/custom/build-integration"}]},{"tab":"PhonePe Switch Integration","hidden":true,"pages":[{"title":"PhonePe Switch Integration","href":"/payments/payment-gateway/web-integration/custom/phonepe-switch"}]},{"tab":"UPI Intent on Mobile Web","hidden":true,"pages":[{"title":"UPI Intent on Mobile Web","href":"/payments/payment-gateway/web-integration/custom/payment-methods/upi-intent-mweb"}]},{"tab":"Save customer card details on Custom Checkout","hidden":true,"pages":[{"title":"Save customer card details on Custom Checkout","href":"/payments/payment-gateway/web-integration/custom/features/saved-cards-old"}]},{"tab":"Prerequisites (Payment Gateway)","hidden":true,"pages":[{"title":"Prerequisites (Payment Gateway)","href":"/payments/payment-gateway/web-integration/hosted"}]},{"tab":"Chargeback on Custom Checkout","hidden":true,"pages":[{"title":"Chargeback on Custom Checkout","href":"/payments/payment-gateway/web-integration/custom/chargeback"}]},{"tab":"Web Integration - Razorpay Standard Checkout","hidden":true,"pages":[{"title":"Web Integration - Razorpay Standard Checkout","href":"/payments/payment-gateway/web-integration/standard/chargeback"}]},{"tab":"Standard Web Integration - Configurability of Payment Methods","hidden":true,"pages":[{"title":"Standard Web Integration - Configurability of Payment Methods","href":"/payments/payment-gateway/web-integration/standard/configure-restrict-payment-methods"}]},{"tab":"About Webview for Mobile Apps","hidden":true,"pages":[{"title":"About Webview for Mobile Apps","href":"/payments/payment-gateway/web-integration/standard/webview"}]},{"tab":"Alipay","hidden":true,"pages":[{"title":"Alipay","href":"/payments/payment-methods/alipay"}]},{"tab":"Pay with Reward Points","hidden":true,"pages":[{"title":"Pay with Reward Points","href":"/payments/payment-methods/apps/reward-points"}]},{"tab":"BharatQR","hidden":true,"pages":[{"title":"BharatQR","href":"/payments/payment-methods/bharatqr"}]},{"tab":"Authentication Type for Cards - Native OTP","hidden":true,"pages":[{"title":"Authentication Type for Cards - Native OTP","href":"/payments/payment-methods/cards/authentication/native-otp"}]},{"tab":"Dynamic Currency Conversion","hidden":true,"pages":[{"title":"Dynamic Currency Conversion","href":"/payments/payment-methods/cards/dynamic-currency-conversion"}]},{"tab":"Google Pay Card Payments","hidden":true,"pages":[{"title":"Google Pay Card Payments","href":"/payments/payment-methods/cards/google-pay"}]},{"tab":"Tokenisation FAQs","hidden":true,"pages":[{"title":"Tokenisation FAQs","href":"/payments/payment-methods/cards/token-hq"}]},{"tab":"DOKU, OVO, and LinkAja","hidden":true,"pages":[{"title":"DOKU, OVO, and LinkAja","href":"/payments/payment-methods/doku-ovo-linkaja"}]},{"tab":"eCOD","hidden":true,"pages":[{"title":"eCOD","href":"/payments/payment-methods/ecod"}]},{"tab":"About Instant EMI Cardless","hidden":true,"pages":[{"title":"About Instant EMI Cardless","href":"/payments/payment-methods/emi/cardless-emi/instant-emi"}]},{"tab":"International Payments - Giropay","hidden":true,"pages":[{"title":"International Payments - Giropay","href":"/payments/payment-methods/giropay"}]},{"tab":"GoPay","hidden":true,"pages":[{"title":"GoPay","href":"/payments/payment-methods/gopay"}]},{"tab":"GrabPay (Malaysia)","hidden":true,"pages":[{"title":"GrabPay (Malaysia)","href":"/payments/payment-methods/grabpay-my"}]},{"tab":"GrabPay (Singapore)","hidden":true,"pages":[{"title":"GrabPay (Singapore)","href":"/payments/payment-methods/grabpay-sg"}]},{"tab":"Klarna","hidden":true,"pages":[{"title":"Klarna","href":"/payments/payment-methods/klarna"}]},{"tab":"International Payments - POLi","hidden":true,"pages":[{"title":"International Payments - POLi","href":"/payments/payment-methods/poli"}]},{"tab":"International Payments - Sofort","hidden":true,"pages":[{"title":"International Payments - Sofort","href":"/payments/payment-methods/sofort"}]},{"tab":"International Payments - Trustly","hidden":true,"pages":[{"title":"International Payments - Trustly","href":"/payments/payment-methods/trustly"}]},{"tab":"UPI QR Code","hidden":true,"pages":[{"title":"UPI QR Code","href":"/payments/payment-methods/upi-qr"}]},{"tab":"Google Spot Platform Integration","hidden":true,"pages":[{"title":"Google Spot Platform Integration","href":"/payments/payment-methods/upi/google-pay/spot-platform-integration"}]},{"tab":"Send GST information in UPI transaction flows","hidden":true,"pages":[{"title":"Send GST information in UPI transaction flows","href":"/payments/payment-methods/upi/gst-on-upi"}]},{"tab":"Zip","hidden":true,"pages":[{"title":"Zip","href":"/payments/payment-methods/zip"}]},{"tab":"Track Payments Using Google Tracking ID and Facebook Pixel","hidden":true,"pages":[{"title":"Track Payments Using Google Tracking ID and Facebook Pixel","href":"/payments/payment-pages/plugins-add-ons"}]},{"tab":"Recurring Payments","hidden":true,"pages":[{"title":"Recurring Payments","href":"/payments/recurring-payments"}]},{"tab":"Account Code","hidden":true,"pages":[{"title":"Account Code","href":"/payments/route/account-code"}]},{"tab":"Direct Settlements","hidden":true,"pages":[{"title":"Direct Settlements","href":"/payments/settlements/direct"}]},{"tab":"Update Expiry Date for an Individual Customer Identifier","hidden":true,"pages":[{"title":"Update Expiry Date for an Individual Customer Identifier","href":"/payments/smart-collect/update-expiry"}]},{"tab":"Razorpay Smart Collect","hidden":true,"pages":[{"title":"Razorpay Smart Collect","href":"/payments/smart-collect/va-vpa-qr"}]},{"tab":"Third-Party Validation (TPV) - Custom Integration","hidden":true,"pages":[{"title":"Third-Party Validation (TPV) - Custom Integration","href":"/payments/third-party-validation/custom-integration"}]},{"tab":"Third-Party Validation (TPV) - S2S Integration","hidden":true,"pages":[{"title":"Third-Party Validation (TPV) - S2S Integration","href":"/payments/third-party-validation/s2s-integration"}]},{"tab":"About TPAP Pro","hidden":true,"pages":[{"title":"About TPAP Pro","href":"/payments/tpap-pro"}]},{"tab":"Razorpay White Label Wallet","hidden":true,"pages":[{"title":"Razorpay White Label Wallet","href":"/payments/wallet"}]},{"tab":"Integrate with HRMS Software","hidden":true,"pages":[{"title":"Integrate with HRMS Software","href":"/payroll/integrations/hrms"}]},{"tab":"Custom Payroll \u0026 Attendance Cycle","hidden":true,"pages":[{"title":"Custom Payroll \u0026 Attendance Cycle","href":"/payroll/quickstart/custom-cycle"}]},{"tab":"FnF Hold Salary Pay Compliance","hidden":true,"pages":[{"title":"FnF Hold Salary Pay Compliance","href":"/payroll/run-payroll/fnf"}]},{"tab":"Testing SSR","hidden":true,"pages":[{"title":"Testing SSR","href":"/test-ssr"}]},{"tab":"Sub-Merchant Onboarding Webhooks - Sample Payload","hidden":true,"pages":[{"title":"Sub-Merchant Onboarding Webhooks - Sample Payload","href":"/webhooks/partners"}]},{"tab":"Integrate Tally","hidden":true,"pages":[{"title":"Integrate Tally","href":"/x/accounting/tally"}]},{"tab":"About Razorpay Capital","hidden":true,"pages":[{"title":"About Razorpay Capital","href":"/x/capital/cards-kyc"}]}]},{"version":"Singapore","pages":[{"title":"Singapore","href":"/sg/home"}]},{"version":"United States","pages":[{"title":"United States","href":"/us/home"}]},{"version":"Malaysia","pages":[{"title":"Malaysia","href":"/my/home"}]}]},"basePath":"","title":"Upload a Document - Razorpay","deploymentId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","buildId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-tiVafkWW.js","utils-CURQcKis.js","cloneDeep-D7WNbvHt.js","_Uint8Array-BY_XlfVz.js","isObject-FP1Yky1u.js","utils-CdFTKPRO.js","addUniqueKeysToSchema-BSfwE63N.js","snippetPresets-BHyg8yZ0.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CQdVXSju.js","isEqual-ft5OxoSH.js","usePlaygroundInputsStore-BILH4rrw.js","shallow-DterCiSU.js","getApiPlaygroundDisplay-uFtORr6j.js","CodeSnippet-BeuhEvUS.js","CodeSnippets-laCoJsvn.js","Page-CTsmHnLF.js","getPastedJson-DOT1n5Lt.js","icon-COH-nmcZ.js","MethodPill-BbAWkCf6.js","DuplicateIcon-CpagiAFQ.js","createIcon-Bw2Dnowf.js","DynamicMarkdown-DzuINhDe.js","SectionHeading-B3H20qI6.js","axios-vUo_bRtp.js"]}