Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.
Stripe Issuing cardholder ID assigned by Bridge for this user.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Privy Docs","colors":{"primary":"#010110","light":"#FFFFFF"},"logo":{"light":"https://mintcdn.com/privy-c2af3412/Ih_Fo3QYM486gzWq/logo/privy-logo-light.png?fit=max\u0026auto=format\u0026n=Ih_Fo3QYM486gzWq\u0026q=85\u0026s=bd297b680ace8a13db4d9ce977f93180","dark":"https://mintcdn.com/privy-c2af3412/Ih_Fo3QYM486gzWq/logo/privy-logo-dark.png?fit=max\u0026auto=format\u0026n=Ih_Fo3QYM486gzWq\u0026q=85\u0026s=24d83970695ab19a1803a2eb00dbea4e"},"favicon":"https://mintcdn.com/privy-c2af3412/YByWVKlFbSpnpSJG/favicon.png?fit=max\u0026auto=format\u0026n=YByWVKlFbSpnpSJG\u0026q=85\u0026s=ee4038168ea586e5f72041e5e2a1f5c8","api":{"openapi":{"source":"https://api.staging.privy.io/v1/openapi.json"},"playground":{"display":"interactive"},"examples":{"languages":["curl","java","javascript","php","go"]},"mdx":{"server":"https://api.privy.io"}},"background":{"color":{"light":"#FFFFFF","dark":"#010110"}},"navbar":{"links":[{"href":"https://demo.privy.io","label":"Demo"},{"href":"https://privy.io/slack","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.privy.io"}},"seo":{"metatags":{"og:type":"website","og:site_name":"Privy Docs","og:image":"https://assets.privy.io/docs-og.png","twitter:title":"Privy Docs","twitter:card":"summary_large_image","twitter:image":"https://assets.privy.io/docs-og.png"},"organization":{"id":"https://www.privy.io/#organization","name":"Privy","url":"https://www.privy.io","logo":"https://assets.privy.io/docs-og.png","sameAs":["https://x.com/privy_io","https://github.com/privy-io"]}},"styling":{"codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"GTM-WV9MVTB3"}},"contextual":{"options":["claude","chatgpt","cursor","vscode","mcp","copy","view"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"privy-c2af3412","hasAudioNarration":false,"actualSubdomain":"privy-c2af3412","customDomains":["docs.privy.io"],"gitSource":{"type":"github","owner":"privy-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4e553b20d11886a4cce74","collectionId":"53384d6e-0531-4740-9e51-f6740a7e4bf4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4e553b20d11886a4cce74"},"feedback":{"issues":true,"thumbs":true,"edits":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":"6ae4e553b20d11886a4cce74","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Wallets","count":282},{"language":"default","tag":"API reference","count":239},{"language":"default","tag":"Recipes","count":139},{"language":"default","tag":"All recipes","count":138},{"language":"default","tag":"Identity","count":130},{"language":"default","tag":"Signatures and transactions","count":90},{"language":"default","tag":"Basics","count":86},{"language":"default","tag":"Users","count":82},{"language":"default","tag":"Financial flows","count":79},{"language":"default","tag":"Controls","count":76}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/privy-c2af3412/4e67a2a256ed8221/style.css"}],"page":{"pagePath":"api-reference/fiat/kyc-server/submit","slug":"/api-reference/fiat/kyc-server/submit","pageMetadata":{"title":"Submit KYC data","openapi":"post /v1/users/{user_id}/kyc/submit","description":"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.","href":"/api-reference/fiat/kyc-server/submit"},"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: \"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Submit KYC data","openapi":"post /v1/users/{user_id}/kyc/submit","description":"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.","href":"/api-reference/fiat/kyc-server/submit"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/privy-c2af3412/9a6cfa36ced76db0/welcome.js","/_mintlify/custom/privy-c2af3412/1af79d46bd64cd8b/fullstory.js","/_mintlify/custom/privy-c2af3412/e4d91321024fde21/recipes/recipes-search.js","/_mintlify/custom/privy-c2af3412/d31c5451398ab22c/check-links.js"],"openApiReferenceData":{"operation":{"tags":["Fiat"],"operationId":"submitKyc","summary":"Submit KYC data","description":"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.","security":["5bcebde3-7c4f-4c20-9c21-62932072b04b"],"parameters":["1e7724da-a2fb-4d6b-a593-a6545537fa6d","76d5389f-91bf-49f2-bdc2-e26c9dc6e5d4"],"requestBody":"6c43fd5c-3ec8-472b-9ab9-9d6b57df9f72","responses":{"200":"f0969f75-dcfd-46a8-9743-4c48c7260dd7"},"method":"post","type":"path","servers":["acec9000-ad38-4fee-a777-c682143596a7"],"path":"/v1/users/{user_id}/kyc/submit","baseUrlOptions":["https://api.privy.io"],"title":"Submit KYC data","codeSamples":[],"requestExampleLanguages":["bash","java","javascript","php","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1e7724da-a2fb-4d6b-a593-a6545537fa6d":{"schema":{"type":"string","description":"The ID of the user.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"user_id","in":"path"},"76d5389f-91bf-49f2-bdc2-e26c9dc6e5d4":{"schema":{"type":"string","description":"ID of your Privy app.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"privy-app-id","in":"header"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["bridge"],"description":"KYC/KYB provider identifier.","title":"KyxProvider","x-stainless-model":"fiat.kyx_provider","isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"data":{"type":"object","properties":{"first_name":{"type":"string","minLength":1,"maxLength":1024,"description":"Legal first name.","uniqueKey":"data.first_name","typeLabel":"string"},"middle_name":{"type":"string","minLength":1,"maxLength":1024,"description":"Legal middle name.","uniqueKey":"data.middle_name","typeLabel":"string"},"last_name":{"type":"string","minLength":1,"maxLength":1024,"description":"Legal last name.","uniqueKey":"data.last_name","typeLabel":"string"},"transliterated_first_name":{"type":"string","minLength":1,"maxLength":256,"description":"Latin-1 transliteration of the first name. Required for non-Latin-1 names.","uniqueKey":"data.transliterated_first_name","typeLabel":"string"},"transliterated_middle_name":{"type":"string","minLength":1,"maxLength":256,"description":"Latin-1 transliteration of the middle name. Required for non-Latin-1 names.","uniqueKey":"data.transliterated_middle_name","typeLabel":"string"},"transliterated_last_name":{"type":"string","minLength":1,"maxLength":256,"description":"Latin-1 transliteration of the last name. Required for non-Latin-1 names.","uniqueKey":"data.transliterated_last_name","typeLabel":"string"},"email":{"type":"string","maxLength":1024,"format":"email","description":"Email address.","uniqueKey":"data.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","maxLength":1024,"description":"Phone number in E.164 format.","uniqueKey":"data.phone","typeLabel":"string"},"date_of_birth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date of birth in YYYY-MM-DD format.","uniqueKey":"data.date_of_birth","typeLabel":"string"},"nationalities":{"type":"array","items":{"type":"string","minLength":3,"maxLength":3,"uniqueKey":"data.nationalities.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"ISO 3166-1 alpha-3 codes for all nationalities held.","uniqueKey":"data.nationalities","typeLabel":"string[]"},"residential_address":{"type":"object","properties":{"street_line_1":{"type":"string","minLength":4,"maxLength":1024,"description":"Street address line 1.","isRequired":true,"uniqueKey":"data.residential_address.street_line_1","typeLabel":"string"},"city":{"type":"string","minLength":1,"maxLength":1024,"description":"City.","isRequired":true,"uniqueKey":"data.residential_address.city","typeLabel":"string"},"country":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 3166-1 alpha-3 country code.","isRequired":true,"uniqueKey":"data.residential_address.country","typeLabel":"string"},"street_line_2":{"type":"string","minLength":1,"maxLength":1024,"description":"Street address line 2.","uniqueKey":"data.residential_address.street_line_2","typeLabel":"string"},"subdivision":{"type":"string","minLength":1,"maxLength":3,"description":"ISO 3166-2 state or province code. Required for US addresses.","uniqueKey":"data.residential_address.subdivision","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":1024,"description":"Postal code. Required for countries that use them.","uniqueKey":"data.residential_address.postal_code","typeLabel":"string"}},"required":["street_line_1","city","country"],"additionalProperties":false,"description":"A postal address used in KYC and KYB data submission.","title":"VerificationAddress","x-stainless-model":"fiat.verification_address","uniqueKey":"data.residential_address","typeLabel":"VerificationAddress · object"},"transliterated_residential_address":{"type":"object","properties":{"street_line_1":{"type":"string","minLength":4,"maxLength":1024,"description":"Street address line 1.","isRequired":true,"uniqueKey":"data.transliterated_residential_address.street_line_1","typeLabel":"string"},"city":{"type":"string","minLength":1,"maxLength":1024,"description":"City.","isRequired":true,"uniqueKey":"data.transliterated_residential_address.city","typeLabel":"string"},"country":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 3166-1 alpha-3 country code.","isRequired":true,"uniqueKey":"data.transliterated_residential_address.country","typeLabel":"string"},"street_line_2":{"type":"string","minLength":1,"maxLength":1024,"description":"Street address line 2.","uniqueKey":"data.transliterated_residential_address.street_line_2","typeLabel":"string"},"subdivision":{"type":"string","minLength":1,"maxLength":3,"description":"ISO 3166-2 state or province code. Required for US addresses.","uniqueKey":"data.transliterated_residential_address.subdivision","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":1024,"description":"Postal code. Required for countries that use them.","uniqueKey":"data.transliterated_residential_address.postal_code","typeLabel":"string"}},"required":["street_line_1","city","country"],"additionalProperties":false,"description":"A postal address used in KYC and KYB data submission.","title":"VerificationAddress","x-stainless-model":"fiat.verification_address","uniqueKey":"data.transliterated_residential_address","typeLabel":"VerificationAddress · object"},"identifying_information":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","maxLength":1024,"description":"Document type identifier.","isRequired":true,"uniqueKey":"data.identifying_information.items.[INDEX].type","typeLabel":"string"},"issuing_country":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 3166-1 alpha-3 issuing country code.","isRequired":true,"uniqueKey":"data.identifying_information.items.[INDEX].issuing_country","typeLabel":"string"},"number":{"type":"string","maxLength":1024,"description":"Document number.","uniqueKey":"data.identifying_information.items.[INDEX].number","typeLabel":"string"},"description":{"type":"string","maxLength":1024,"description":"Document description.","uniqueKey":"data.identifying_information.items.[INDEX].description","typeLabel":"string"},"expiration":{"type":"string","maxLength":1024,"description":"Document expiration date.","uniqueKey":"data.identifying_information.items.[INDEX].expiration","typeLabel":"string"},"image_front":{"type":"string","maxLength":34952664,"description":"Base64-encoded front image.","uniqueKey":"data.identifying_information.items.[INDEX].image_front","typeLabel":"string"},"image_back":{"type":"string","maxLength":34952664,"description":"Base64-encoded back image.","uniqueKey":"data.identifying_information.items.[INDEX].image_back","typeLabel":"string"}},"required":["type","issuing_country"],"additionalProperties":false,"description":"An identifying document for KYC or KYB verification. Also used for business identifiers such as tax and registration numbers, for which the image and expiration fields do not apply.","title":"VerificationDocument","x-stainless-model":"fiat.verification_document","uniqueKey":"data.identifying_information.items.[INDEX]","typeLabel":"VerificationDocument · object"},"minItems":1,"maxItems":1000,"description":"Identifying documents.","uniqueKey":"data.identifying_information","typeLabel":"VerificationDocument · object[]"},"stripe_link_shared_data_id":{"type":"string","maxLength":1024,"pattern":"^lsd_[^\\s\\p{Cc}]+$","description":"Stripe Link shared data ID that supplies name, date of birth, address, and US SSN (omit those fields); retrieval errors surface in endorsements[].issues.","uniqueKey":"data.stripe_link_shared_data_id","typeLabel":"string"},"nonresident_alien_attestation":{"type":"boolean","description":"Attests the user is a nonresident alien to satisfy identification without a US tax ID (must be enabled for you).","uniqueKey":"data.nonresident_alien_attestation","typeLabel":"boolean"},"kyc_screen":{"type":"object","properties":{"screened_at":{"oneOf":[{"type":"string","description":"When the screen was performed (ISO 8601 date or date-time).","format":"date-time","isRequired":true,"uniqueKey":"data.kyc_screen.screened_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","description":"When the screen was performed (ISO 8601 date or date-time).","format":"date","isRequired":true,"uniqueKey":"data.kyc_screen.screened_at.oneOf.1","typeLabel":"string\u003cdate>"}],"isRequired":true,"uniqueKey":"data.kyc_screen.screened_at","typeLabel":"string\u003cdate-time> | string\u003cdate>"},"result":{"type":"string","enum":["passed","failed"],"description":"Outcome of a screen performed under KYC/KYB reliance.","title":"KyxScreenResult","example":"passed","x-stainless-model":"fiat.kyx_screen_result","isRequired":true,"uniqueKey":"data.kyc_screen.result","typeLabel":"enum\u003cstring>"}},"required":["screened_at","result"],"additionalProperties":false,"description":"Result of a KYC/AML or OFAC screen you performed and are relying on the provider to accept, honoured only for developers enrolled in reliance.","title":"KyxScreen","x-stainless-model":"fiat.kyx_screen","uniqueKey":"data.kyc_screen","typeLabel":"KyxScreen · object"},"ofac_screen":{"type":"object","properties":{"screened_at":{"oneOf":[{"type":"string","description":"When the screen was performed (ISO 8601 date or date-time).","format":"date-time","isRequired":true,"uniqueKey":"data.ofac_screen.screened_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","description":"When the screen was performed (ISO 8601 date or date-time).","format":"date","isRequired":true,"uniqueKey":"data.ofac_screen.screened_at.oneOf.1","typeLabel":"string\u003cdate>"}],"isRequired":true,"uniqueKey":"data.ofac_screen.screened_at","typeLabel":"string\u003cdate-time> | string\u003cdate>"},"result":{"type":"string","enum":["passed","failed"],"description":"Outcome of a screen performed under KYC/KYB reliance.","title":"KyxScreenResult","example":"passed","x-stainless-model":"fiat.kyx_screen_result","isRequired":true,"uniqueKey":"data.ofac_screen.result","typeLabel":"enum\u003cstring>"}},"required":["screened_at","result"],"additionalProperties":false,"description":"Result of a KYC/AML or OFAC screen you performed and are relying on the provider to accept, honoured only for developers enrolled in reliance.","title":"KyxScreen","x-stainless-model":"fiat.kyx_screen","uniqueKey":"data.ofac_screen","typeLabel":"KyxScreen · object"},"verified_database_at":{"oneOf":[{"type":"string","description":"When you verified the user against a database source (ISO 8601), which loosens the identifying-document requirement under reliance.","format":"date-time","uniqueKey":"data.verified_database_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","description":"When you verified the user against a database source (ISO 8601), which loosens the identifying-document requirement under reliance.","format":"date","uniqueKey":"data.verified_database_at.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"data.verified_database_at","typeLabel":"string\u003cdate-time> | string\u003cdate>"},"verified_govid_at":{"oneOf":[{"type":"string","description":"When you verified the government ID (ISO 8601), which loosens the identifying-document requirement under reliance.","format":"date-time","uniqueKey":"data.verified_govid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","description":"When you verified the government ID (ISO 8601), which loosens the identifying-document requirement under reliance.","format":"date","uniqueKey":"data.verified_govid_at.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"data.verified_govid_at","typeLabel":"string\u003cdate-time> | string\u003cdate>"},"verified_proof_of_address_at":{"oneOf":[{"type":"string","description":"When you verified proof of address (ISO 8601), required for EEA customers and SEPA rails under reliance.","format":"date-time","uniqueKey":"data.verified_proof_of_address_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","description":"When you verified proof of address (ISO 8601), required for EEA customers and SEPA rails under reliance.","format":"date","uniqueKey":"data.verified_proof_of_address_at.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"data.verified_proof_of_address_at","typeLabel":"string\u003cdate-time> | string\u003cdate>"}},"additionalProperties":false,"description":"KYC verification data for headless submission.","title":"KycSubmitData","x-stainless-model":"fiat.kyc_submit_data","isRequired":true,"uniqueKey":"data","typeLabel":"KycSubmitData · object"},"environment":{"type":"string","enum":["production","sandbox"],"description":"Provider environment (production or sandbox).","title":"KyxEnvironment","x-stainless-model":"fiat.kyx_environment","uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"endorsements":{"type":"array","items":{"type":"string","maxLength":256,"description":"Endorsement identifier.","title":"KyxEndorsementName","example":"sepa","x-stainless-model":"fiat.kyx_endorsement_name","uniqueKey":"endorsements.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Endorsements to request during KYC.","uniqueKey":"endorsements","typeLabel":"string[]"},"client_agreement_id":{"type":"string","minLength":1,"maxLength":1024,"description":"Client-side agreement ID for ToS acceptance.","uniqueKey":"client_agreement_id","typeLabel":"string"}},"required":["provider","data"],"additionalProperties":false,"description":"Request body for headless KYC data submission.","title":"KycSubmitRequestBody","x-stainless-model":"fiat.kyc_submit_request_body","uniqueKey":"","typeLabel":"KycSubmitRequestBody · object"},"examples":{"Example":{"title":"Example","value":{"provider":"bridge","data":{"first_name":"\u003cstring>","middle_name":"\u003cstring>","last_name":"\u003cstring>","transliterated_first_name":"\u003cstring>","transliterated_middle_name":"\u003cstring>","transliterated_last_name":"\u003cstring>","email":"[email protected]","phone":"\u003cstring>","date_of_birth":"\u003cstring>","nationalities":["\u003cstring>"],"identifying_information":[{"type":"\u003cstring>","issuing_country":"\u003cstring>","number":"\u003cstring>","description":"\u003cstring>","expiration":"\u003cstring>","image_front":"\u003cstring>","image_back":"\u003cstring>"}],"stripe_link_shared_data_id":"\u003cstring>","nonresident_alien_attestation":true,"verified_database_at":"2023-11-07T05:31:56Z","verified_govid_at":"2023-11-07T05:31:56Z","verified_proof_of_address_at":"2023-11-07T05:31:56Z"},"endorsements":["sepa"],"client_agreement_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f0969f75-dcfd-46a8-9743-4c48c7260dd7":{"description":"KYC status snapshot reflecting the submitted data.","content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["bridge"],"description":"KYC/KYB provider identifier.","title":"KyxProvider","x-stainless-model":"fiat.kyx_provider","isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"environment":{"type":"string","enum":["production","sandbox"],"description":"Provider environment (production or sandbox).","title":"KyxEnvironment","x-stainless-model":"fiat.kyx_environment","isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"KYC/KYB status for the user.","title":"KyxProviderStatus","example":"approved","x-stainless-model":"fiat.kyx_provider_status","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"tos":{"type":"object","properties":{"status":{"type":"string","description":"Status of Terms of Service acceptance. Passthrough from the provider.","title":"KyxTosStatus","example":"approved","x-stainless-model":"fiat.kyx_tos_status","isRequired":true,"uniqueKey":"tos.status","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"ToS acceptance link, if pending.","uniqueKey":"tos.link","typeLabel":"string\u003curi>"}},"required":["status"],"description":"Terms of Service acceptance status for a KYC or KYB flow.","title":"KyxTosStatusDetail","x-stainless-model":"fiat.kyx_tos_status_detail","isRequired":true,"uniqueKey":"tos","typeLabel":"KyxTosStatusDetail · object"},"endorsements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":256,"description":"Endorsement identifier.","title":"KyxEndorsementName","example":"sepa","x-stainless-model":"fiat.kyx_endorsement_name","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","description":"Status of an endorsement. Passthrough from the provider.","title":"KyxEndorsementStatus","example":"approved","x-stainless-model":"fiat.kyx_endorsement_status","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].status","typeLabel":"string"},"missing":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"endorsements.items.[INDEX].missing.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Missing requirements, or null if complete.","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].missing.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Missing requirements, or null if complete.","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].missing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"endorsements.items.[INDEX].missing","typeLabel":"string[] | null"},"issues":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"endorsements.items.[INDEX].issues.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Provider issue codes, or null if none.","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].issues.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Provider issue codes, or null if none.","isRequired":true,"uniqueKey":"endorsements.items.[INDEX].issues.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"endorsements.items.[INDEX].issues","typeLabel":"string[] | null"}},"required":["name","status","missing","issues"],"description":"An endorsement with its approval status and missing requirements.","title":"KyxEndorsement","x-stainless-model":"fiat.kyx_endorsement","uniqueKey":"endorsements.items.[INDEX]","typeLabel":"KyxEndorsement · object"},"isRequired":true,"uniqueKey":"endorsements","typeLabel":"KyxEndorsement · object[]"},"capabilities":{"type":"object","properties":{"payin_crypto":{"type":"string","description":"Status of a capability. Passthrough from the provider.","title":"KyxCapabilityStatus","example":"active","x-stainless-model":"fiat.kyx_capability_status","isRequired":true,"uniqueKey":"capabilities.payin_crypto","typeLabel":"string"},"payout_crypto":{"type":"string","description":"Status of a capability. Passthrough from the provider.","title":"KyxCapabilityStatus","example":"active","x-stainless-model":"fiat.kyx_capability_status","isRequired":true,"uniqueKey":"capabilities.payout_crypto","typeLabel":"string"},"payin_fiat":{"type":"string","description":"Status of a capability. Passthrough from the provider.","title":"KyxCapabilityStatus","example":"active","x-stainless-model":"fiat.kyx_capability_status","isRequired":true,"uniqueKey":"capabilities.payin_fiat","typeLabel":"string"},"payout_fiat":{"type":"string","description":"Status of a capability. Passthrough from the provider.","title":"KyxCapabilityStatus","example":"active","x-stainless-model":"fiat.kyx_capability_status","isRequired":true,"uniqueKey":"capabilities.payout_fiat","typeLabel":"string"}},"required":["payin_crypto","payout_crypto","payin_fiat","payout_fiat"],"description":"Capability statuses for the customer.","title":"KyxCapabilities","x-stainless-model":"fiat.kyx_capabilities","isRequired":true,"uniqueKey":"capabilities","typeLabel":"KyxCapabilities · object"},"requirements_due":{"type":"array","items":{"type":"string","uniqueKey":"requirements_due.items.[INDEX]","typeLabel":"string"},"description":"Top-level items still needed (e.g. link a bank account).","isRequired":true,"uniqueKey":"requirements_due","typeLabel":"string[]"},"future_requirements_due":{"type":"array","items":{"type":"string","uniqueKey":"future_requirements_due.items.[INDEX]","typeLabel":"string"},"description":"Items that will be required in the future.","isRequired":true,"uniqueKey":"future_requirements_due","typeLabel":"string[]"},"kyc":{"type":"object","properties":{"status":{"type":"string","description":"Status of KYC/KYB verification. Passthrough from the provider.","title":"KyxVerificationStatus","example":"approved","x-stainless-model":"fiat.kyx_verification_status","isRequired":true,"uniqueKey":"kyc.status","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Verification link, if applicable.","uniqueKey":"kyc.link","typeLabel":"string\u003curi>"},"rejection_reasons":{"type":"array","items":{"type":"string","uniqueKey":"kyc.rejection_reasons.items.[INDEX]","typeLabel":"string"},"description":"Reasons for rejection, if status is closed or action_required.","uniqueKey":"kyc.rejection_reasons","typeLabel":"string[]"}},"required":["status"],"description":"Verification status detail for a KYC or KYB check.","title":"KyxVerificationStatusDetail","x-stainless-model":"fiat.kyx_verification_status_detail","isRequired":true,"uniqueKey":"kyc","typeLabel":"KyxVerificationStatusDetail · object"},"stripe_cardholder_id":{"type":"string","description":"Stripe Issuing cardholder ID assigned by Bridge for this user.","uniqueKey":"stripe_cardholder_id","typeLabel":"string"}},"required":["provider","environment","status","tos","endorsements","capabilities","requirements_due","future_requirements_due","kyc"],"description":"Full KYC status for a user with a given provider.","title":"KycStatusResponse","x-stainless-model":"fiat.kyc_status_response","uniqueKey":"","typeLabel":"KycStatusResponse · object"},"examples":{"Example":{"title":"Example","value":{"provider":"bridge","environment":"production","status":"approved","tos":{"status":"approved","link":"\u003cstring>"},"endorsements":[{"name":"sepa","status":"approved","missing":["\u003cstring>"],"issues":["\u003cstring>"]}],"capabilities":{"payin_crypto":"active","payout_crypto":"active","payin_fiat":"active","payout_fiat":"active"},"requirements_due":["\u003cstring>"],"future_requirements_due":["\u003cstring>"],"kyc":{"status":"approved","link":"\u003cstring>","rejection_reasons":["\u003cstring>"]},"stripe_cardholder_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5bcebde3-7c4f-4c20-9c21-62932072b04b":{"appSecretAuth":{"type":"http","scheme":"basic","description":"Basic Auth header with your app ID as the username and your app secret as the password.","scopes":[],"schemeName":"appSecretAuth"}}},"servers":{"acec9000-ad38-4fee-a777-c682143596a7":{"url":"https://api.privy.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic Auth header with your app ID as the username and your app secret as the password.","scopes":[],"schemeName":"appSecretAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic Auth header with your app ID as the username and your app secret as the password.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"appSecretAuth","name":"Authorization"}],"title":"appSecretAuth"}]},"originalFileLocation":"https://api.staging.privy.io/v1/openapi.json"},"subdomain":"privy-c2af3412","siteName":"Privy Docs","title":"Submit KYC data - Privy Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T18:18:05.104Z","originalFileLocation":"api-reference/fiat/kyc-server/submit.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=\"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Privy Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Submit KYC data - Privy Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Privy Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.privy.io/api-reference/fiat/kyc-server/submit\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://assets.privy.io/docs-og.png\">\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=\"Privy Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://assets.privy.io/docs-og.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Privy Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#010110\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.privy.io/api-reference/fiat/kyc-server/submit\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/fiat/kyc-server/submit.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.privy.io/#organization\",\"name\":\"Privy\",\"url\":\"https://www.privy.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets.privy.io/docs-og.png\"},\"sameAs\":[\"https://x.com/privy_io\",\"https://github.com/privy-io\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.privy.io#website\",\"name\":\"Privy Docs\",\"url\":\"https://docs.privy.io\",\"publisher\":{\"@id\":\"https://www.privy.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit#webpage\",\"url\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit\",\"name\":\"Submit KYC data\",\"description\":\"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.\",\"dateModified\":\"2026-10-09T18:18:05.104Z\",\"isPartOf\":{\"@id\":\"https://docs.privy.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Identity\",\"item\":\"https://docs.privy.io/api-reference/users/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Users\",\"item\":\"https://docs.privy.io/api-reference/users/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"KYC\",\"item\":\"https://docs.privy.io/api-reference/fiat/kyc-server/get\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Submit KYC data\",\"item\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit#apireference\",\"headline\":\"Submit KYC data\",\"name\":\"Submit KYC data\",\"description\":\"Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.\",\"url\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit\",\"mainEntityOfPage\":{\"@id\":\"https://docs.privy.io/api-reference/fiat/kyc-server/submit#webpage\"},\"image\":\"https://assets.privy.io/docs-og.png\",\"dateModified\":\"2026-10-09T18:18:05.104Z\",\"publisher\":{\"@id\":\"https://www.privy.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.privy.io#website\"}}]}\u003c/script>","siteName":"Privy Docs","nav":{"global":null,"tabs":[{"tab":"Basics","pages":[{"title":"Basics","href":"/basics/get-started/about"}]},{"tab":"Wallets","menu":[{"item":"Overview","pages":[{"title":"Overview","href":"/wallets/overview"}]},{"item":"Embedded wallets","pages":[{"title":"Embedded wallets","href":"/wallets/overview/embedded"}]},{"item":"Organization wallets","pages":[{"title":"Organization wallets","href":"/organizations/overview"}]},{"item":"External wallets","pages":[{"title":"External wallets","href":"/wallets/connectors/overview"}]},{"item":"Signatures and transactions","pages":[{"title":"Signatures and transactions","href":"/wallets/signatures-and-transactions"}]},{"item":"Balances and webhooks","pages":[{"title":"Balances and webhooks","href":"/wallets/gas-and-asset-management/assets/overview"}]},{"item":"Gas and fee management","pages":[{"title":"Gas and fee management","href":"/wallets/gas-and-asset-management/gas/overview"}]}],"pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Financial flows","menu":[{"item":"Overview","pages":[{"title":"Overview","href":"/financial-flows/overview"}]},{"item":"Deposits","pages":[{"title":"Deposits","href":"/financial-flows/deposits/overview"}]},{"item":"Payouts","pages":[{"title":"Payouts","href":"/financial-flows/payouts/overview"}]},{"item":"Earn","pages":[{"title":"Earn","href":"/wallets/actions/earn/overview"}]},{"item":"Cards","pages":[{"title":"Cards","href":"/financial-flows/cards/overview"}]},{"item":"Trade","pages":[{"title":"Trade","href":"/wallets/actions/swap/overview"}]},{"item":"Monetization","pages":[{"title":"Monetization","href":"/financial-flows/monetization"}]},{"item":"Treasury management","pages":[{"title":"Treasury management","href":"/treasury-management/overview"}]},{"item":"Private transactions","pages":[{"title":"Private transactions","href":"/financial-flows/private-transactions"}]}],"pages":[{"title":"Financial flows","href":"/financial-flows/overview"}]},{"tab":"Controls and policies","menu":[{"item":"Controls","pages":[{"title":"Controls","href":"/controls/overview"}]},{"item":"Policies","pages":[{"title":"Policies","href":"/controls/policies/overview"}]},{"item":"Manual approvals","pages":[{"title":"Manual approvals","href":"/controls/dashboard/overview"}]}],"pages":[{"title":"Controls and policies","href":"/controls/overview"}]},{"tab":"Identity","menu":[{"item":"Authentication","pages":[{"title":"Authentication","href":"/authentication/overview"}]},{"item":"Users","pages":[{"title":"Users","href":"/user-management/users/overview"}]},{"item":"KYC and KYB","pages":[{"title":"KYC and KYB","href":"/kyc-kyb/overview"}]}],"pages":[{"title":"Identity","href":"/authentication/overview"}]},{"tab":"Security","pages":[{"title":"Security","href":"/security/overview"}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/overview"}]},{"tab":"API reference","groups":[{"group":"Basics","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authorization signatures","href":"/api-reference/authorization-signatures"},{"title":"Idempotency keys","href":"/api-reference/idempotency-keys"},{"title":"Request expiry","href":"/api-reference/request-expiry"},{"title":"Webhooks overview","sidebarTitle":"Webhooks","href":"/api-reference/webhooks/overview"},{"title":"Privy labs APIs","sidebarTitle":"Privy labs","href":"/api-reference/labs/overview"}]},{"group":"Wallets","pages":[{"group":"Wallets","pages":[{"title":"Create wallet","openapi":"post /v1/wallets","href":"/api-reference/wallets/create"},{"title":"Create wallets in batch","openapi":"post /v1/wallets/batch","href":"/api-reference/wallets/batch-create"},{"title":"Create custodial wallets","openapi":"post /v1/custodial_wallets","href":"/api-reference/wallets/custodial-wallets"},{"title":"Get wallet","openapi":"get /v1/wallets/{wallet_id}","href":"/api-reference/wallets/get"},{"title":"Get wallets","openapi":"get /v1/wallets","href":"/api-reference/wallets/get-all"},{"title":"Get wallet by address","openapi":"post /v1/wallets/address","href":"/api-reference/wallets/get-by-address"},{"title":"Update wallet","openapi":"patch /v1/wallets/{wallet_id}","href":"/api-reference/wallets/update"},{"title":"Assign wallet entity","openapi":"post /v1/wallets/{wallet_id}/entity","href":"/api-reference/wallets/entity"},{"title":"Archive wallet","openapi":"post /v1/wallets/{wallet_id}/archive","href":"/api-reference/wallets/archive"},{"title":"Get balance","openapi":"get /v1/wallets/{wallet_id}/balance","href":"/api-reference/wallets/get-balance"},{"title":"Get transactions","openapi":"get /v1/wallets/{wallet_id}/transactions","href":"/api-reference/wallets/get-transactions"},{"title":"Export wallet","openapi":"post /v1/wallets/{wallet_id}/export","href":"/api-reference/wallets/export"},{"group":"Import wallet","pages":[{"title":"Initialize import","openapi":"post /v1/wallets/import/init","href":"/api-reference/wallets/import/init"},{"title":"Submit import","openapi":"post /v1/wallets/import/submit","href":"/api-reference/wallets/import/submit"}]},{"title":"Authenticate","openapi":"post /v1/wallets/authenticate","href":"/api-reference/wallets/authenticate"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet.archived","title":"Wallet archived","href":"/api-reference/webhooks/wallet/archived"},{"openapi":"webhook wallet.restored","title":"Wallet restored","href":"/api-reference/webhooks/wallet/restored"},{"openapi":"webhook wallet.funds_deposited","title":"Funds deposited","href":"/api-reference/webhooks/wallet/funds_deposited"},{"openapi":"webhook wallet.funds_withdrawn","title":"Funds withdrawn","href":"/api-reference/webhooks/wallet/funds_withdrawn"},{"openapi":"webhook wallet.private_key_export","title":"Private key export","href":"/api-reference/webhooks/wallet/private_key_export"},{"openapi":"webhook wallet.recovered","title":"Wallet recovered","href":"/api-reference/webhooks/wallet/recovered"},{"openapi":"webhook wallet.recovery_setup","title":"Wallet recovery setup","href":"/api-reference/webhooks/wallet/recovery_setup"},{"openapi":"webhook user_operation.completed","title":"User operation completed","href":"/api-reference/webhooks/user-operation/completed"}]}]},{"group":"Signatures and transactions","pages":[{"group":"Ethereum","pages":[{"title":"eth_sendTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-send-transaction"},{"title":"wallet_sendCalls","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/wallet-send-calls"},{"title":"personal_sign","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/personal-sign"},{"title":"eth_signTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-sign-transaction"},{"title":"eth_signTypedData_v4","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-signtypeddata-v4"},{"title":"eth_signUserOperation","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-sign-user-operation"},{"title":"eth_sign7702Authorization","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-sign-7702-authorization"},{"title":"secp256k1_sign","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/secp256k1-sign"}]},{"group":"Solana","pages":[{"title":"signMessage","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/solana/sign-message"},{"title":"signTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/solana/sign-transaction"},{"title":"signAndSendTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/solana/sign-and-send-transaction"}]},{"group":"Tempo","pages":[{"title":"eth_sendTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/tempo/eth-send-transaction"},{"title":"eth_signTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/tempo/eth-sign-transaction"}]},{"group":"Tron","pages":[{"title":"tron_sendTransaction","href":"/api-reference/wallets/tron/tron-send-transaction"},{"title":"tron_signTransaction","href":"/api-reference/wallets/tron/tron-sign-transaction"}]},{"group":"Spark BTC","pages":[{"title":"getBalance","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-balance"},{"title":"transfer","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/transfer"},{"title":"transferTokens","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/transfer-tokens"},{"title":"getStaticDepositAddress","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-static-deposit-address"},{"title":"claimStaticDeposit","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/claim-static-deposit"},{"title":"getClaimStaticDepositQuote","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-static-deposit-quote"},{"title":"createLightningInvoice","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/create-lightning-invoice"},{"title":"payLightningInvoice","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/pay-lightning-invoice"},{"title":"signMessageWithIdentityKey","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/sign-message-with-identity-key"},{"title":"getWithdrawalFeeQuote","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-withdrawal-fee-quote"},{"title":"withdraw","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/withdraw"}]},{"group":"Other chains","pages":[{"title":"Raw sign","openapi":"post /v1/wallets/{wallet_id}/raw_sign","href":"/api-reference/wallets/raw-sign"}]},{"group":"Transactions","pages":[{"title":"Get transaction","openapi":"get /v1/transactions/{transaction_id}","href":"/api-reference/transactions/get"},{"title":"Get transaction by external ID","openapi":"get /v1/transactions","href":"/api-reference/transactions/external-id"},{"title":"Get gas spend","openapi":"get /v1/apps/gas_spend","href":"/api-reference/transactions/gas-spend"},{"group":"Webhooks","pages":[{"openapi":"webhook transaction.broadcasted","title":"Transaction broadcasted","href":"/api-reference/webhooks/transaction/broadcasted"},{"openapi":"webhook transaction.confirmed","title":"Transaction confirmed","href":"/api-reference/webhooks/transaction/confirmed"},{"openapi":"webhook transaction.execution_reverted","title":"Transaction execution reverted","href":"/api-reference/webhooks/transaction/execution_reverted"},{"openapi":"webhook transaction.failed","title":"Transaction failed","href":"/api-reference/webhooks/transaction/failed"},{"openapi":"webhook transaction.provider_error","title":"Transaction provider error","href":"/api-reference/webhooks/transaction/provider_error"},{"openapi":"webhook transaction.replaced","title":"Transaction replaced","href":"/api-reference/webhooks/transaction/replaced"},{"openapi":"webhook transaction.still_pending","title":"Transaction still pending","href":"/api-reference/webhooks/transaction/still_pending"}]}]}]},{"group":"Deposits","pages":[{"group":"Fiat","pages":[{"title":"Create fiat deposit account","openapi":"post /v1/wallets/{wallet_id}/deposit_accounts/fiat","href":"/api-reference/fiat/deposit-accounts/create"},{"title":"List fiat deposit accounts","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/fiat","href":"/api-reference/fiat/deposit-accounts/list"},{"title":"Get fiat deposit account","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/fiat/{deposit_account_id}","href":"/api-reference/fiat/deposit-accounts/get"}]},{"group":"Crypto","pages":[{"title":"Create crypto deposit account","openapi":"post /v1/wallets/{wallet_id}/deposit_accounts/crypto","href":"/api-reference/crypto-deposits/create"},{"title":"Quote crypto deposit account","openapi":"post /v1/deposit_accounts/crypto/quote","href":"/api-reference/crypto-deposits/quote"},{"title":"Get crypto deposit account order","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/crypto/orders/{order_id}","href":"/api-reference/crypto-deposits/get-order"},{"title":"Get next crypto deposit account order","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/crypto/next_order","href":"/api-reference/crypto-deposits/get-next-order"}]}]},{"group":"Payouts","pages":[{"group":"Fiat","pages":[{"title":"Create a payout","openapi":"post /v1/wallets/{wallet_id}/payout/fiat","href":"/api-reference/wallets/payout/create"},{"group":"External fiat accounts","pages":[{"group":"For users","pages":[{"title":"Create external fiat account","openapi":"post /v1/users/{user_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/create"},{"title":"List external fiat accounts","openapi":"get /v1/users/{user_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/list"},{"title":"Get external fiat account","openapi":"get /v1/users/{user_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/get"},{"title":"Delete external fiat account","openapi":"delete /v1/users/{user_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/delete"}]},{"group":"For organizations","pages":[{"title":"Create external fiat account","openapi":"post /v1/organizations/{organization_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/organizations/create"},{"title":"List external fiat accounts","openapi":"get /v1/organizations/{organization_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/organizations/list"},{"title":"Get external fiat account","openapi":"get /v1/organizations/{organization_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/organizations/get"},{"title":"Delete external fiat account","openapi":"delete /v1/organizations/{organization_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/organizations/delete"}]}]}]},{"group":"Crypto","pages":[{"title":"Transfer","openapi":"post /v1/wallets/{wallet_id}/transfer","href":"/api-reference/wallets/transfer/index"},{"title":"Quote transfer fees","openapi":"post /v1/wallets/{wallet_id}/transfer/quote","href":"/api-reference/wallets/transfer/quote"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet_action.transfer.created","title":"Transfer created","href":"/api-reference/webhooks/wallet-action/transfer/created"},{"openapi":"webhook wallet_action.transfer.succeeded","title":"Transfer succeeded","href":"/api-reference/webhooks/wallet-action/transfer/succeeded"},{"openapi":"webhook wallet_action.transfer.failed","title":"Transfer failed","href":"/api-reference/webhooks/wallet-action/transfer/failed"},{"openapi":"webhook wallet_action.transfer.rejected","title":"Transfer rejected","href":"/api-reference/webhooks/wallet-action/transfer/rejected"}]}]}]},{"group":"Swaps","pages":[{"title":"Get swap quote","openapi":"post /v1/wallets/{wallet_id}/swap/quote","href":"/api-reference/wallets/swap/quote"},{"title":"Swap tokens","openapi":"post /v1/wallets/{wallet_id}/swap","href":"/api-reference/wallets/swap/tokens"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet_action.swap.created","title":"Swap created","href":"/api-reference/webhooks/wallet-action/swap/created"},{"openapi":"webhook wallet_action.swap.succeeded","title":"Swap succeeded","href":"/api-reference/webhooks/wallet-action/swap/succeeded"},{"openapi":"webhook wallet_action.swap.failed","title":"Swap failed","href":"/api-reference/webhooks/wallet-action/swap/failed"},{"openapi":"webhook wallet_action.swap.rejected","title":"Swap rejected","href":"/api-reference/webhooks/wallet-action/swap/rejected"}]}]},{"group":"Earn","pages":[{"title":"Deposit into vault","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/deposit","href":"/api-reference/wallets/earn/deposit"},{"title":"Withdraw from vault","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/withdraw","href":"/api-reference/wallets/earn/withdraw"},{"title":"Claim reward incentives","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/incentive/claim","href":"/api-reference/wallets/earn/incentive-claim"},{"title":"Get incentive rewards","openapi":"get /v1/wallets/{wallet_id}/earn/ethereum/incentive/claim","href":"/api-reference/wallets/earn/get-incentive-rewards"},{"title":"Get Ethereum vault details","openapi":"get /v1/earn/ethereum/vaults/{vault_id}","href":"/api-reference/wallets/earn/get-vault-details"},{"title":"Get Ethereum vault position","openapi":"get /v1/wallets/{wallet_id}/earn/ethereum/vaults","href":"/api-reference/wallets/earn/get-position"},{"title":"Earn fee collect","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/fees/collect","href":"/api-reference/wallets/earn/fees-collect"},{"group":"Webhooks","pages":[{"group":"Earn deposits","pages":[{"openapi":"webhook wallet_action.earn_deposit.created","title":"Earn deposit created","href":"/api-reference/webhooks/wallet-action/earn-deposit/created"},{"title":"Earn deposit succeeded","openapi":"webhook wallet_action.earn_deposit.succeeded","href":"/api-reference/webhooks/wallet-action/earn-deposit/succeeded"},{"title":"Earn deposit failed","openapi":"webhook wallet_action.earn_deposit.failed","href":"/api-reference/webhooks/wallet-action/earn-deposit/failed"},{"title":"Earn deposit rejected","openapi":"webhook wallet_action.earn_deposit.rejected","href":"/api-reference/webhooks/wallet-action/earn-deposit/rejected"}]},{"group":"Earn withdrawals","pages":[{"title":"Earn withdraw created","openapi":"webhook wallet_action.earn_withdraw.created","href":"/api-reference/webhooks/wallet-action/earn-withdraw/created"},{"title":"Earn withdraw succeeded","openapi":"webhook wallet_action.earn_withdraw.succeeded","href":"/api-reference/webhooks/wallet-action/earn-withdraw/succeeded"},{"title":"Earn withdraw failed","openapi":"webhook wallet_action.earn_withdraw.failed","href":"/api-reference/webhooks/wallet-action/earn-withdraw/failed"},{"title":"Earn withdraw rejected","openapi":"webhook wallet_action.earn_withdraw.rejected","href":"/api-reference/webhooks/wallet-action/earn-withdraw/rejected"}]},{"group":"Earn incentive claims","pages":[{"title":"Earn reward incentive claim created","openapi":"webhook wallet_action.earn_incentive_claim.created","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/created"},{"title":"Earn reward incentive claim succeeded","openapi":"webhook wallet_action.earn_incentive_claim.succeeded","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/succeeded"},{"title":"Earn reward incentive claim failed","openapi":"webhook wallet_action.earn_incentive_claim.failed","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/failed"},{"title":"Earn reward incentive claim rejected","openapi":"webhook wallet_action.earn_incentive_claim.rejected","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/rejected"}]},{"group":"Earn fee collections","pages":[{"title":"Earn fee collect created","openapi":"webhook wallet_action.earn_fee_collect.created","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/created"},{"title":"Earn fee collect succeeded","openapi":"webhook wallet_action.earn_fee_collect.succeeded","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/succeeded"},{"title":"Earn fee collect failed","openapi":"webhook wallet_action.earn_fee_collect.failed","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/failed"},{"title":"Earn fee collect rejected","openapi":"webhook wallet_action.earn_fee_collect.rejected","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/rejected"}]}]}]},{"group":"Wallet actions","pages":[{"title":"Get wallet action","openapi":"get /v1/wallets/{wallet_id}/actions/{action_id}","href":"/api-reference/wallets/actions/get"},{"title":"Get wallet action by external ID","openapi":"get /v1/actions","href":"/api-reference/wallets/actions/external-id"},{"title":"List all wallet actions","openapi":"get /v1/wallets/{wallet_id}/actions","href":"/api-reference/wallets/actions/list"}]}]},{"group":"Controls","pages":[{"group":"Key quorums","pages":[{"title":"Create key quorum","openapi":"post /v1/key_quorums","href":"/api-reference/key-quorums/create"},{"title":"Get key quorums","openapi":"get /v1/key_quorums","href":"/api-reference/key-quorums/get-all"},{"title":"Get key quorum","openapi":"get /v1/key_quorums/{key_quorum_id}","href":"/api-reference/key-quorums/get"},{"title":"Update key quorum","openapi":"patch /v1/key_quorums/{key_quorum_id}","href":"/api-reference/key-quorums/update"},{"title":"Delete key quorum","openapi":"delete /v1/key_quorums/{key_quorum_id}","href":"/api-reference/key-quorums/delete"}]},{"group":"Policies","pages":[{"title":"Create policy","openapi":"post /v1/policies","href":"/api-reference/policies/create"},{"title":"Get policies","openapi":"get /v1/policies","href":"/api-reference/policies/get-all"},{"title":"Get policy","openapi":"get /v1/policies/{policy_id}","href":"/api-reference/policies/get"},{"title":"Update policy","openapi":"patch /v1/policies/{policy_id}","href":"/api-reference/policies/update"},{"title":"Delete policy","openapi":"delete /v1/policies/{policy_id}","href":"/api-reference/policies/delete"},{"group":"Rules","pages":[{"title":"Add a rule to a policy","openapi":"post /v1/policies/{policy_id}/rules","href":"/api-reference/policies/rules/create"},{"title":"Get a rule from a policy","openapi":"get /v1/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/rules/get"},{"title":"Update a rule in a policy","openapi":"patch /v1/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/rules/update"},{"title":"Delete a rule from a policy","openapi":"delete /v1/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/rules/delete"}]}]},{"group":"Condition sets","pages":[{"title":"Create condition set","openapi":"post /v1/condition_sets","href":"/api-reference/condition-sets/create"},{"title":"Get condition sets","openapi":"get /v1/condition_sets","href":"/api-reference/condition-sets/get-all"},{"title":"Get condition set","openapi":"get /v1/condition_sets/{condition_set_id}","href":"/api-reference/condition-sets/get"},{"title":"Update condition set","openapi":"patch /v1/condition_sets/{condition_set_id}","href":"/api-reference/condition-sets/update"},{"title":"Delete condition set","openapi":"delete /v1/condition_sets/{condition_set_id}","href":"/api-reference/condition-sets/delete"},{"group":"Condition set items","pages":[{"title":"Add items to a condition set","openapi":"post /v1/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/condition-sets/condition-set-items/create"},{"title":"Get an item from a condition set","openapi":"get /v1/condition_sets/{condition_set_id}/condition_set_items/{condition_set_item_id}","href":"/api-reference/condition-sets/condition-set-items/get"},{"title":"Get all items from a condition set","openapi":"get /v1/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/condition-sets/condition-set-items/get-all"},{"title":"Update items in a condition set","openapi":"put /v1/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/condition-sets/condition-set-items/update"},{"title":"Delete an item from a condition set","openapi":"delete /v1/condition_sets/{condition_set_id}/condition_set_items/{condition_set_item_id}","href":"/api-reference/condition-sets/condition-set-items/delete"}]}]},{"group":"Aggregations","pages":[{"title":"Create aggregation","openapi":"post /v1/aggregations","href":"/api-reference/aggregations/create"},{"title":"Get aggregation","openapi":"get /v1/aggregations/{aggregation_id}","href":"/api-reference/aggregations/get"},{"title":"Delete aggregation","openapi":"delete /v1/aggregations/{aggregation_id}","href":"/api-reference/aggregations/delete"}]},{"group":"Wallet automations","pages":[{"title":"Create wallet automation","openapi":"post /v1/wallet_automations","href":"/api-reference/wallet-automations/create"},{"title":"List wallet automations","openapi":"get /v1/wallet_automations","href":"/api-reference/wallet-automations/list"},{"title":"Get wallet automation","openapi":"get /v1/wallet_automations/{automation_id}","href":"/api-reference/wallet-automations/get"},{"title":"Update wallet automation","openapi":"patch /v1/wallet_automations/{automation_id}","href":"/api-reference/wallet-automations/update"},{"title":"Delete wallet automation","openapi":"delete /v1/wallet_automations/{automation_id}","href":"/api-reference/wallet-automations/delete"},{"group":"Wallet attachments","pages":[{"title":"Attach wallet automations","openapi":"post /v1/wallets/{wallet_id}/automations/attach","href":"/api-reference/wallet-automations/attach"},{"title":"Detach wallet automations","openapi":"post /v1/wallets/{wallet_id}/automations/detach","href":"/api-reference/wallet-automations/detach"}]},{"title":"List wallet automation executions","openapi":"get /v1/wallet_automations/executions","href":"/api-reference/wallet-automations/list-executions"},{"title":"Reindex wallet automations","openapi":"post /v1/wallet_automations/reindex","href":"/api-reference/wallet-automations/reindex"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet_automation.submitted","title":"Wallet automation submitted","href":"/api-reference/webhooks/wallet-automation/submitted"}]}]}]},{"group":"Identity","pages":[{"group":"Users","pages":[{"title":"Create user","openapi":"post /v1/users","playground":"interactive","href":"/api-reference/users/create"},{"group":"Get user","pages":[{"title":"Get user by ID","openapi":"get /v1/users/{user_id}","href":"/api-reference/users/get"},{"group":"Linked accounts","pages":[{"title":"Get user by wallet address","openapi":"post /v1/users/wallet/address","href":"/api-reference/users/get-by-wallet-address"},{"title":"Get user by smart wallet address","openapi":"post /v1/users/smart_wallet/address","href":"/api-reference/users/get-by-smart-wallet-address"},{"title":"Get user by custom auth ID","openapi":"post /v1/users/custom_auth/id","href":"/api-reference/users/get-by-custom-auth"},{"title":"Get user by email address","openapi":"post /v1/users/email/address","href":"/api-reference/users/get-by-email-address"},{"title":"Get user by phone number","openapi":"post /v1/users/phone/number","href":"/api-reference/users/get-by-phone-number"},{"title":"Get user by Discord username","openapi":"post /v1/users/discord/username","href":"/api-reference/users/get-by-discord-username"},{"title":"Get user by GitHub username","openapi":"post /v1/users/github/username","href":"/api-reference/users/get-by-github-username"},{"title":"Get user by Instagram username","openapi":"post /v1/users/instagram/username","href":"/api-reference/users/get-by-instagram-username"},{"title":"Get user by Twitter username","openapi":"post /v1/users/twitter/username","href":"/api-reference/users/get-by-twitter-username"},{"title":"Get user by Twitter subject","openapi":"post /v1/users/twitter/subject","href":"/api-reference/users/get-by-twitter-subject"},{"title":"Get user by Telegram username","openapi":"post /v1/users/telegram/username","href":"/api-reference/users/get-by-telegram-username"},{"title":"Get user by Telegram user ID","openapi":"post /v1/users/telegram/telegram_user_id","href":"/api-reference/users/get-by-telegram-user-id"},{"title":"Get user by Farcaster ID","openapi":"post /v1/users/farcaster/fid","href":"/api-reference/users/get-by-farcaster-id"},{"title":"Get user by Spotify subject","openapi":"post /v1/users/spotify/subject","href":"/api-reference/users/get-by-spotify-subject"},{"title":"Get user by Twitch username","openapi":"post /v1/users/twitch/username","href":"/api-reference/users/get-by-twitch-username"}]}]},{"title":"Get users","openapi":"get /v1/users","playground":"interactive","href":"/api-reference/users/get-all"},{"title":"Search users","openapi":"post /v1/users/search","href":"/api-reference/users/search"},{"title":"Refresh Twitter account","api":"post /v1/users/twitter/refresh","href":"/api-reference/users/refresh-twitter-account"},{"title":"Delete user","openapi":"delete /v1/users/{user_id}","href":"/api-reference/users/delete"},{"title":"Freeze user","openapi":"post /v1/users/{user_id}/freeze","href":"/api-reference/users/freeze"},{"title":"Unfreeze user","openapi":"delete /v1/users/{user_id}/freeze","href":"/api-reference/users/unfreeze"},{"title":"Add custom metadata","openapi":"post /v1/users/{user_id}/custom_metadata","href":"/api-reference/users/custom-metadata/create"},{"title":"Update custom metadata","openapi":"patch /v1/users/{user_id}/custom_metadata","href":"/api-reference/users/custom-metadata/update"},{"title":"Pregenerate wallets","openapi":"post /v1/users/{user_id}/wallets","href":"/api-reference/users/pregenerate-wallets"},{"group":"MFA","pages":[{"group":"SMS","pages":[{"title":"Start SMS MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/sms/enrollment/init","href":"/api-reference/users/mfa/sms/enrollment/init"},{"title":"Complete SMS MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/sms/enrollment/verify","href":"/api-reference/users/mfa/sms/enrollment/verify"},{"title":"Start SMS MFA verification","openapi":"post /v1/users/{user_id}/mfa/sms/verification/init","href":"/api-reference/users/mfa/sms/verification/init"},{"title":"Complete SMS MFA verification","openapi":"post /v1/users/{user_id}/mfa/sms/verification/verify","href":"/api-reference/users/mfa/sms/verification/verify"}]},{"group":"TOTP","pages":[{"title":"Start TOTP MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/totp/enrollment/init","href":"/api-reference/users/mfa/totp/enrollment/init"},{"title":"Complete TOTP MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/totp/enrollment/verify","href":"/api-reference/users/mfa/totp/enrollment/verify"},{"title":"Complete TOTP MFA verification","openapi":"post /v1/users/{user_id}/mfa/totp/verification/verify","href":"/api-reference/users/mfa/totp/verification/verify"}]},{"group":"Passkey","pages":[{"title":"Start passkey MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/passkey/enrollment/init","href":"/api-reference/users/mfa/passkey/enrollment/init"},{"title":"Complete passkey MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/passkey/enrollment/verify","href":"/api-reference/users/mfa/passkey/enrollment/verify"},{"title":"Start passkey MFA verification","openapi":"post /v1/users/{user_id}/mfa/passkey/verification/init","href":"/api-reference/users/mfa/passkey/verification/init"},{"title":"Complete passkey MFA verification","openapi":"post /v1/users/{user_id}/mfa/passkey/verification/verify","href":"/api-reference/users/mfa/passkey/verification/verify"}]}]},{"group":"Allowlist","pages":[{"title":"List allowlist entries","openapi":"get /v1/apps/{app_id}/allowlist","href":"/api-reference/apps/list-allowlist"},{"title":"Add to allowlist","openapi":"post /v1/apps/{app_id}/allowlist","href":"/api-reference/apps/add-to-allowlist"},{"title":"Remove from allowlist","openapi":"delete /v1/apps/{app_id}/allowlist","href":"/api-reference/apps/remove-from-allowlist"}]},{"group":"Webhooks","pages":[{"openapi":"webhook user.authenticated","title":"User authenticated","href":"/api-reference/webhooks/user/authenticated"},{"openapi":"webhook user.created","title":"User created","href":"/api-reference/webhooks/user/created"},{"openapi":"webhook user.deleted","title":"User deleted","href":"/api-reference/webhooks/user/deleted"},{"openapi":"webhook user.linked_account","title":"User linked account","href":"/api-reference/webhooks/user/linked_account"},{"openapi":"webhook user.transferred_account","title":"User transferred account","href":"/api-reference/webhooks/user/transferred_account"},{"openapi":"webhook user.unlinked_account","title":"User unlinked account","href":"/api-reference/webhooks/user/unlinked_account"},{"openapi":"webhook user.updated_account","title":"User updated account","href":"/api-reference/webhooks/user/updated_account"},{"openapi":"webhook user.wallet_created","title":"User wallet created","href":"/api-reference/webhooks/user/wallet_created"},{"openapi":"webhook mfa.disabled","title":"MFA disabled","href":"/api-reference/webhooks/mfa/disabled"},{"openapi":"webhook mfa.enabled","title":"MFA enabled","href":"/api-reference/webhooks/mfa/enabled"}]},{"group":"KYC","pages":[{"title":"Get KYC status","openapi":"get /v1/users/{user_id}/kyc","href":"/api-reference/fiat/kyc-server/get"},{"title":"Initiate KYC terms of service","openapi":"post /v1/users/{user_id}/kyc/tos","href":"/api-reference/fiat/kyc-server/tos"},{"title":"Initiate KYC verification","openapi":"post /v1/users/{user_id}/kyc/links","description":"Generates a hosted KYC link for the user and returns the current KYC status snapshot.","href":"/api-reference/fiat/kyc-server/links"},{"title":"Submit KYC data","openapi":"post /v1/users/{user_id}/kyc/submit","href":"/api-reference/fiat/kyc-server/submit"}]}]},{"group":"Organizations","pages":[{"title":"Create organization","openapi":"post /v1/organizations","description":"Create an organization in an app.","href":"/api-reference/organizations/create"},{"title":"List organizations","openapi":"get /v1/organizations","href":"/api-reference/organizations/get-all"},{"title":"Get organization","openapi":"get /v1/organizations/{organization_id}","href":"/api-reference/organizations/get"},{"title":"Update organization","openapi":"patch /v1/organizations/{organization_id}","href":"/api-reference/organizations/update"},{"title":"Delete organization","openapi":"delete /v1/organizations/{organization_id}","href":"/api-reference/organizations/delete"},{"group":"KYB","pages":[{"title":"Get KYB status","openapi":"get /v1/organizations/{organization_id}/kyb","href":"/api-reference/fiat/kyb/get"},{"title":"Initiate KYB terms of service","openapi":"post /v1/organizations/{organization_id}/kyb/tos","href":"/api-reference/fiat/kyb/tos"},{"title":"Initiate KYB verification","openapi":"post /v1/organizations/{organization_id}/kyb/links","href":"/api-reference/fiat/kyb/links"},{"title":"Submit KYB data","openapi":"post /v1/organizations/{organization_id}/kyb/submit","href":"/api-reference/fiat/kyb/submit"}]}]}]},{"group":"Intents","pages":[{"group":"Usage","pages":[{"title":"Get intent","openapi":"get /v1/intents/{intent_id}","href":"/api-reference/intents/get"},{"title":"List intents","openapi":"get /v1/intents","href":"/api-reference/intents/list"},{"title":"Create RPC transaction","openapi":"post /v1/intents/wallets/{wallet_id}/rpc","href":"/api-reference/intents/rpc"},{"title":"Create transfer action","openapi":"post /v1/intents/wallets/{wallet_id}/transfer","href":"/api-reference/intents/transfer"},{"title":"Authorize intent","openapi":"post /v1/intents/{intent_id}/authorize","href":"/api-reference/intents/authorize"},{"title":"Reject intent","openapi":"post /v1/intents/{intent_id}/reject","href":"/api-reference/intents/reject"}]},{"group":"Resource update intents","pages":[{"title":"Update wallet","openapi":"patch /v1/intents/wallets/{wallet_id}","href":"/api-reference/intents/update-wallet"},{"title":"Update key quorum","openapi":"patch /v1/intents/key_quorums/{key_quorum_id}","href":"/api-reference/intents/update-key-quorum"},{"title":"Update policy","openapi":"patch /v1/intents/policies/{policy_id}","href":"/api-reference/intents/update-policy"},{"title":"Create rule","openapi":"post /v1/intents/policies/{policy_id}/rules","href":"/api-reference/intents/create-rule"},{"title":"Update policy rule","openapi":"patch /v1/intents/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/intents/update-rule"},{"title":"Delete rule","openapi":"delete /v1/intents/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/intents/delete-rule"}]},{"group":"Webhooks","pages":[{"openapi":"webhook intent.created","title":"Intent created","href":"/api-reference/webhooks/intents/created"},{"openapi":"webhook intent.authorized","title":"Intent authorized","href":"/api-reference/webhooks/intents/authorized"},{"openapi":"webhook intent.rejected","title":"Intent rejected","href":"/api-reference/webhooks/intents/rejected"},{"openapi":"webhook intent.executed","title":"Intent executed","href":"/api-reference/webhooks/intents/executed"},{"openapi":"webhook intent.failed","title":"Intent failed","href":"/api-reference/webhooks/intents/failed"}]}]},{"group":"Credit usage","pages":[{"group":"Webhooks","pages":[{"openapi":"webhook usage.gas_sponsorship.recorded","title":"Gas sponsorship charge recorded","href":"/api-reference/webhooks/usage/gas_sponsorship_recorded"},{"openapi":"webhook usage.swap_provider_fee.recorded","title":"Swap provider fee charge recorded","href":"/api-reference/webhooks/usage/swap_provider_fee_recorded"}]}]},{"group":"Labs","pages":[{"group":"Swaps","pages":[{"title":"Advanced swap (Solana)","openapi":"post /v1/wallets/{wallet_id}/experimental/solana/advanced-swap","href":"/api-reference/labs/advanced-swap"}]}]}]}]},"basePath":"","title":"Submit KYC data - Privy Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}