{
"statusCode": 400,
"message": "fiatAmount must be a positive number.",
"code": "validation_error"
}
{
"statusCode": 400,
"message": "fiatAmount must be a positive number.",
"code": "validation_error"
}
Customers
Create Customer
The customers API is a KYC API for DeFi wallets. Onboard and verify your
end-users, then link their wallet addresses so verified identity travels
with their on-chain activity.
Create a customer and start KYC. Returns a hosted verification URL.
Reasons why the customer isn't approved. This is surfaced to show your
end-user why verification is stuck, declined, or needs action. Omitted when the customer is approved or in_progress. Returned with refresh=true, and also on the customer.kyc.updated webhook.
Show child attributes
Example:
[ { "code": "COULD_NOT_PERFORM_AML_SCREENING", "severity": "error", "feature": "aml_screenings", "message": "Could not retrieve data from KYC for performing AML Screening." } ]
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Stablepay","colors":{"primary":"#111111","light":"#FFFFFF","dark":"#111111"},"logo":{"light":"https://mintcdn.com/stablepay-887f520b/cI5E4tpmtoI-t0AU/logo/Spay_Logo_Dark.png?fit=max\u0026auto=format\u0026n=cI5E4tpmtoI-t0AU\u0026q=85\u0026s=5befa97ea55f6d53f9e5f811652e19c5","dark":"https://mintcdn.com/stablepay-887f520b/cI5E4tpmtoI-t0AU/logo/Spay_Logo_Light.png?fit=max\u0026auto=format\u0026n=cI5E4tpmtoI-t0AU\u0026q=85\u0026s=76a86f7a22952da689684255bd18d3ad"},"favicon":"https://mintcdn.com/stablepay-887f520b/wTGAlsaiHobywJ3U/favicon.png?fit=max\u0026auto=format\u0026n=wTGAlsaiHobywJ3U\u0026q=85\u0026s=52cafbf50782c6c17b4e006670465029","api":{"openapi":"openapi.yaml","playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.stablepay.ai"}},"navbar":{"links":[{"href":"mailto:hello@stablepay.ai","label":"Support"}],"primary":{"type":"button","label":"Console","href":"https://console.stablepay.ai/"}},"footer":{"socials":{"github":"https://github.com/katlegorphele/stablepay"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stablepay-887f520b","hasAudioNarration":false,"actualSubdomain":"stablepay-887f520b","customDomains":["developers.stablepay.ai"],"gitSource":{"type":"github","owner":"katlegostablepay","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad5ea9e7e3343e90aaac828","collectionId":"59efe044-3002-48a4-8d69-d7cf3a539087","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad5ea9e7e3343e90aaac828"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad5ea9e7e3343e90aaac828","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Stablepay Network API","count":18},{"language":"default","tag":"Payments","count":5},{"language":"default","tag":"Customers","count":4},{"language":"default","tag":"Account","count":3},{"language":"default","tag":"Reversals","count":3},{"language":"default","tag":"Webhooks","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJbecmNE.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJnecmNE.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJfecg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\np,.prose p{margin-bottom:0.75em}"}],"page":{"pagePath":"customers/create-customer","slug":"/customers/create-customer","pageMetadata":{"title":"Create Customer","openapi":"POST /v1/customers","description":"The customers API is a KYC API for DeFi wallets. Onboard and verify your\nend-users, then link their wallet addresses so verified identity travels\nwith their on-chain activity.\n\nCreate a customer and start KYC. Returns a hosted verification URL.\n","href":"/customers/create-customer"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The customers API is a KYC API for DeFi wallets. Onboard and verify your\\nend-users, then link their wallet addresses so verified identity travels\\nwith their on-chain activity.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Create a customer and start KYC. Returns a hosted verification URL.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Customer","openapi":"POST /v1/customers","description":"The customers API is a KYC API for DeFi wallets. Onboard and verify your\nend-users, then link their wallet addresses so verified identity travels\nwith their on-chain activity.\n\nCreate a customer and start KYC. Returns a hosted verification URL.\n","href":"/customers/create-customer"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createCustomer","summary":"Create a customer","description":"The customers API is a KYC API for DeFi wallets. Onboard and verify your\nend-users, then link their wallet addresses so verified identity travels\nwith their on-chain activity.\n\nCreate a customer and start KYC. Returns a hosted verification URL.\n","tags":["Customers"],"requestBody":"f322f8d6-4d42-4864-9535-d9b3c6e6b4c8","responses":{"201":"0b06e4e8-b7b3-4cff-a9da-bbecbae92d4e","401":"5352175c-91bd-471d-937b-83629af33477","409":"e241a816-3aa5-4810-acdc-fa56827f40b4"},"method":"post","type":"path","servers":["64229404-700b-4b5d-b1c1-ae0295ffbb33"],"security":["3c89b25c-53af-4505-8256-2b49ea513607"],"path":"/v1/customers","baseUrlOptions":["https://api.stablepay.ai"],"title":"Create a customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"externalId":{"type":"string","description":"Your own unique identifier for the customer.","example":"user001","isRequired":true,"uniqueKey":"externalId","typeLabel":"string"},"type":{"type":"string","enum":["individual","business"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","example":"user@example.com","uniqueKey":"email","typeLabel":"string"},"phone":{"type":"string","example":"+254712345678","uniqueKey":"phone","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2.","example":"KE","uniqueKey":"countryCode","typeLabel":"string"},"metadata":{"type":"object","description":"Optional key-value data. Do not include personal information.","uniqueKey":"metadata","typeLabel":"object"}},"required":["externalId","type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"externalId":"user001","email":"user@example.com","phone":"+254712345678","countryCode":"KE","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"0b06e4e8-b7b3-4cff-a9da-bbecbae92d4e":{"description":"Customer created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Prefixed ULID for this customer.","example":"cus_01KXG3R0X8DXTKB849FFFEPT7Y","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"externalId":{"type":"string","example":"user001","isRequired":true,"uniqueKey":"externalId","typeLabel":"string"},"type":{"type":"string","enum":["individual","business"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"kycStatus":{"type":"string","description":"One of none, pending, in_progress, review, approved, declined, soft_declined, expired, abandoned.","example":"approved","isRequired":true,"uniqueKey":"kycStatus","typeLabel":"string"},"kycAttempts":{"type":"integer","example":1,"isRequired":true,"uniqueKey":"kycAttempts","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"countryCode":{"oneOf":[{"type":"string","example":"KE","uniqueKey":"countryCode.oneOf.0","typeLabel":"string"},{"type":"null","example":"KE","uniqueKey":"countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"countryCode","typeLabel":"string | null"},"riskLevel":{"oneOf":[{"type":"string","uniqueKey":"riskLevel.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"riskLevel.oneOf.1","typeLabel":"null"}],"uniqueKey":"riskLevel","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"verifiedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"verifiedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"verifiedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"verifiedAt","typeLabel":"string\u003cdate-time> | null"},"verificationUrl":{"oneOf":[{"type":"string","description":"Hosted verification URL. Returned when a verification is started.","example":"https://verify.didit.me/session/XXXX","uniqueKey":"verificationUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hosted verification URL. Returned when a verification is started.","example":"https://verify.didit.me/session/XXXX","uniqueKey":"verificationUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"verificationUrl","typeLabel":"string | null"},"sessionId":{"oneOf":[{"type":"string","uniqueKey":"sessionId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"sessionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"sessionId","typeLabel":"string | null"},"identity":{"oneOf":[{"type":"object","description":"The verified identity. Returned only with refresh=true.","uniqueKey":"identity.oneOf.0","typeLabel":"object"},{"type":"null","description":"The verified identity. Returned only with refresh=true.","uniqueKey":"identity.oneOf.1","typeLabel":"null"}],"uniqueKey":"identity","typeLabel":"object | null"},"reviewWarnings":{"oneOf":[{"type":"array","description":"Reasons why the customer isn't approved. This is surfaced to show your\nend-user why verification is stuck, declined, or needs action. Omitted when the customer is approved or in_progress. Returned with refresh=true, and also on the customer.kyc.updated webhook.\n","items":{"type":"object","properties":{"code":{"type":"string","example":"COULD_NOT_PERFORM_AML_SCREENING","isRequired":true,"uniqueKey":"reviewWarnings.oneOf.0.items.[INDEX].code","typeLabel":"string"},"severity":{"type":"string","example":"error","isRequired":true,"uniqueKey":"reviewWarnings.oneOf.0.items.[INDEX].severity","typeLabel":"string"},"feature":{"type":"string","example":"aml_screenings","isRequired":true,"uniqueKey":"reviewWarnings.oneOf.0.items.[INDEX].feature","typeLabel":"string"},"message":{"type":"string","example":"Could not retrieve data from KYC for performing AML Screening.","isRequired":true,"uniqueKey":"reviewWarnings.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["code","severity","feature","message"],"uniqueKey":"reviewWarnings.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[{"code":"COULD_NOT_PERFORM_AML_SCREENING","severity":"error","feature":"aml_screenings","message":"Could not retrieve data from KYC for performing AML Screening."}],"uniqueKey":"reviewWarnings.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Reasons why the customer isn't approved. This is surfaced to show your\nend-user why verification is stuck, declined, or needs action. Omitted when the customer is approved or in_progress. Returned with refresh=true, and also on the customer.kyc.updated webhook.\n","items":{"type":"object","properties":{"code":{"type":"string","example":"COULD_NOT_PERFORM_AML_SCREENING"},"severity":{"type":"string","example":"error"},"feature":{"type":"string","example":"aml_screenings"},"message":{"type":"string","example":"Could not retrieve data from KYC for performing AML Screening."}},"required":["code","severity","feature","message"]},"example":[{"code":"COULD_NOT_PERFORM_AML_SCREENING","severity":"error","feature":"aml_screenings","message":"Could not retrieve data from KYC for performing AML Screening."}],"uniqueKey":"reviewWarnings.oneOf.1","typeLabel":"null"}],"uniqueKey":"reviewWarnings","typeLabel":"object[] | null"}},"required":["id","externalId","type","kycStatus","kycAttempts","createdAt","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cus_01KXG3R0X8DXTKB849FFFEPT7Y","externalId":"user001","type":"individual","kycStatus":"approved","kycAttempts":1,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","countryCode":"KE","riskLevel":"\u003cstring>","metadata":{},"verifiedAt":"2023-11-07T05:31:56Z","verificationUrl":"https://verify.didit.me/session/XXXX","sessionId":"\u003cstring>","identity":{},"reviewWarnings":[{"code":"COULD_NOT_PERFORM_AML_SCREENING","severity":"error","feature":"aml_screenings","message":"Could not retrieve data from KYC for performing AML Screening."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5352175c-91bd-471d-937b-83629af33477":{"description":"Invalid or missing API key.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error message.","example":"fiatAmount must be a positive number.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code.","example":"validation_error","uniqueKey":"code","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"fiatAmount must be a positive number.","code":"validation_error"}}},"exampleType":"generated"}},"exampleType":"generated"},"e241a816-3aa5-4810-acdc-fa56827f40b4":{"description":"A customer with this externalId already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error message.","example":"fiatAmount must be a positive number.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code.","example":"validation_error","uniqueKey":"code","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"fiatAmount must be a positive number.","code":"validation_error"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3c89b25c-53af-4505-8256-2b49ea513607":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Stablepay API key. Include as `Authorization: Bearer \u003ckey>`.\n","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"64229404-700b-4b5d-b1c1-ae0295ffbb33":{"url":"https://api.stablepay.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Stablepay API key. Include as `Authorization: Bearer \u003ckey>`.\n","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Stablepay API key. Include as `Authorization: Bearer \u003ckey>`.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"stablepay-887f520b","siteName":"Stablepay","title":"Create Customer - Stablepay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-31T07:18:51.857Z","originalFileLocation":"customers/create-customer.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=\"The customers API is a KYC API for DeFi wallets. Onboard and verify your end-users, then link their wallet addresses so verified identity travels with their on-chain activity. Create a customer and start KYC. Returns a hosted verification URL.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stablepay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stablepay-887f520b/WhaiQRttnkN5Dr4u/_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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stablepay-887f520b/WhaiQRttnkN5Dr4u/_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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Customer - Stablepay\">\u003cmeta data-mint-head property=\"og:description\" content=\"The customers API is a KYC API for DeFi wallets. Onboard and verify your end-users, then link their wallet addresses so verified identity travels with their on-chain activity. Create a customer and start KYC. Returns a hosted verification URL.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stablepay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.stablepay.ai/customers/create-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stablepay-887f520b.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+Customer\u0026amp;description=The+customers+API+is+a+KYC+API+for+DeFi+wallets.+Onboard+and+verify+your%0Aend-users%2C+then+link+their+wallet+addresses+so+verified+identity+travels%0Awith+their+on-\u0026amp;theme=28058e50a44532d89ff42e12\u0026amp;signature=3a4cc50a9a83757008915e343d78a081b502f94126ad21411c99e5e05af0f78b\">\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=\"Create Customer - Stablepay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The customers API is a KYC API for DeFi wallets. Onboard and verify your end-users, then link their wallet addresses so verified identity travels with their on-chain activity. Create a customer and start KYC. Returns a hosted verification URL.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stablepay-887f520b.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+Customer\u0026amp;description=The+customers+API+is+a+KYC+API+for+DeFi+wallets.+Onboard+and+verify+your%0Aend-users%2C+then+link+their+wallet+addresses+so+verified+identity+travels%0Awith+their+on-\u0026amp;theme=28058e50a44532d89ff42e12\u0026amp;signature=3a4cc50a9a83757008915e343d78a081b502f94126ad21411c99e5e05af0f78b\">\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/stablepay-887f520b/WhaiQRttnkN5Dr4u/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stablepay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.stablepay.ai/customers/create-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/customers/create-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.stablepay.ai/#organization\",\"name\":\"Stablepay\",\"url\":\"https://developers.stablepay.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stablepay-887f520b/cI5E4tpmtoI-t0AU/logo/Spay_Logo_Dark.png?fit=max\u0026auto=format\u0026n=cI5E4tpmtoI-t0AU\u0026q=85\u0026s=5befa97ea55f6d53f9e5f811652e19c5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.stablepay.ai#website\",\"name\":\"Stablepay\",\"url\":\"https://developers.stablepay.ai\",\"publisher\":{\"@id\":\"https://developers.stablepay.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.stablepay.ai/customers/create-customer#webpage\",\"url\":\"https://developers.stablepay.ai/customers/create-customer\",\"name\":\"Create Customer\",\"description\":\"The customers API is a KYC API for DeFi wallets. Onboard and verify your end-users, then link their wallet addresses so verified identity travels with their on-chain activity. Create a customer and start KYC. Returns a hosted verification URL.\",\"dateModified\":\"2026-07-31T07:18:51.857Z\",\"isPartOf\":{\"@id\":\"https://developers.stablepay.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.stablepay.ai/customers/create-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.stablepay.ai/customers/create-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Stablepay\",\"item\":\"https://developers.stablepay.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Customer\",\"item\":\"https://developers.stablepay.ai/customers/create-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.stablepay.ai/customers/create-customer#apireference\",\"headline\":\"Create Customer\",\"name\":\"Create Customer\",\"description\":\"The customers API is a KYC API for DeFi wallets. Onboard and verify your end-users, then link their wallet addresses so verified identity travels with their on-chain activity. Create a customer and start KYC. Returns a hosted verification URL.\",\"url\":\"https://developers.stablepay.ai/customers/create-customer\",\"mainEntityOfPage\":{\"@id\":\"https://developers.stablepay.ai/customers/create-customer#webpage\"},\"dateModified\":\"2026-07-31T07:18:51.857Z\",\"publisher\":{\"@id\":\"https://developers.stablepay.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.stablepay.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stablepay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Stablepay","nav":{"global":null,"tabs":[{"tab":"Stablepay Network API","groups":[{"group":"Account","pages":[{"title":"Validate Account","openapi":"POST /v1/account/validate","href":"/validate-account"},{"title":"List Supported Banks","openapi":"GET /v1/account/banks","href":"/banks"},{"title":"List Supported Merchants","openapi":"GET /v1/account/merchants","href":"/merchants"}]},{"group":"Payments","pages":[{"title":"Create Payment","openapi":"POST /v1/payments/out","href":"/create-payment"},{"title":"Create Payin","openapi":"POST /v1/payments/in","href":"/create-payin"},{"title":"Get Payment","openapi":"GET /v1/payments/{paymentId}","href":"/get-payment"},{"title":"List Payments","openapi":"GET /v1/payments","href":"/list-payments"},{"title":"FX Rate","openapi":"openapi.yaml GET /v1/fx/convert","href":"/fx-rate"}]},{"group":"Reversals","pages":[{"title":"Create Reversal","openapi":"POST /v1/reversals","href":"/reversals/request-reversal"},{"title":"Get Reversal","openapi":"GET /v1/reversals/{reversalId}","href":"/reversals/get-reversal"},{"title":"List Reversals","openapi":"GET /v1/reversals","description":"Returns your reversals, newest first.","href":"/reversals/list-reversals"}]},{"group":"Customers","pages":[{"title":"Create Customer","openapi":"POST /v1/customers","href":"/customers/create-customer"},{"title":"Reverify Customer","openapi":"POST /v1/customers/{customerId}/verification","hidden":false,"description":"Start a new verification for a customer. Limited to three retries.\n","href":"/customers/reverify-customer"},{"title":"Link Wallet","openapi":"POST /v1/customers/{customerId}/wallets","href":"/customers/link-wallet"},{"title":"Get Customer","openapi":"GET /v1/customers/{customerId}","href":"/customers/get-customer"}]},{"group":"Webhooks","pages":[{"title":"Register Webhook","openapi":"POST /v1/webhooks/register","href":"/webhooks/register"},{"title":"Replay Webhook","openapi":"POST /v1/webhooks/replay/{event_id}","href":"/webhooks/replay-event"},{"title":"List Webhook Events","openapi":"GET /v1/webhooks/events","href":"/webhooks/list-events"}]}]}]},"basePath":"","title":"Create Customer - Stablepay","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}