This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact’s identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact email.
{
"errors": {
"message": "Email can't be blank"
}
}
{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"Hello Clever","colors":{"primary":"#004CC9","light":"#00CCFF","dark":"#004CC9"},"logo":{"light":"https://mintcdn.com/helloclever-8a6f7f0c/S7QMDoXOC49VUXaT/hello-clever-logo-light.svg?fit=max\u0026auto=format\u0026n=S7QMDoXOC49VUXaT\u0026q=85\u0026s=4a928e1c744ef4dedb8b8afff710d1ac","dark":"https://mintcdn.com/helloclever-8a6f7f0c/S7QMDoXOC49VUXaT/hello-clever-logo-dark.svg?fit=max\u0026auto=format\u0026n=S7QMDoXOC49VUXaT\u0026q=85\u0026s=261f8d8f2593c7ad69fd436fd4e4c33a"},"favicon":"https://mintcdn.com/helloclever-8a6f7f0c/5Mqdqt3zrVgQSzUr/favicon.png?fit=max\u0026auto=format\u0026n=5Mqdqt3zrVgQSzUr\u0026q=85\u0026s=e12c39efb6a5c43f946efde200ac710c","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","prefill":false}},"background":{"color":{"light":"#ffffff","dark":"#1C1C1E"}},"navbar":{"links":[{"href":"https://support.helloclever.co/merchant-knowledge-base","label":"Support"}],"primary":{"type":"button","label":"Merchant Portal","href":"https://merchant.helloclever.co"}},"footer":{"socials":{"facebook":"https://www.facebook.com/helloclever.co","x":"https://x.com/hello_clever","instagram":"https://www.instagram.com/helloclever.co","linkedin":"https://www.linkedin.com/company/helloclever","youtube":"https://www.youtube.com/@hello_clever"},"links":[{"header":"Support","items":[{"label":"Merchant Support","href":"https://support.helloclever.co/merchant-knowledge-base"},{"label":"Consumer Support","href":"https://support.helloclever.co/consumer-knowledge-base/faqs"},{"label":"Developer Portal","href":"https://docs.helloclever.co"},{"label":"Terms \u0026 Conditions","href":"https://helloclever.co/terms"},{"label":"Privacy Policy","href":"https://helloclever.co/policy"},{"label":"Compliments And Complaints","href":"https://helloclever.co/compliments-and-complaints"}]},{"header":"Company","items":[{"label":"Our Partners","href":"https://helloclever.co/our-partners"},{"label":"Careers","href":"https://helloclever.notion.site/Careers-Hello-Clever-119c8c68c1c54eb5b858202ef8a1cccf"},{"label":"Contact Us","href":"https://helloclever.co/get-in-touch"},{"label":"Blog","href":"https://helloclever.co/blogs"}]}]},"seo":{"metatags":{"og:site_name":"Hello Clever","og:title":"Hello Clever Developer Docs","og:description":"Guides and API references for Hello Clever's multi-currency payment gateway, card, and cashback APIs, plus Clever AI tools for merchants and developers.","og:image":"https://docs.helloclever.co/images/og-img-doc-site.png","og:url":"https://docs.helloclever.co","og:type":"website"},"indexing":"navigable"},"fonts":{"family":"Sora"},"banner":{"content":"You are viewing the new Hello Clever documentation site. For legacy documentation, visit [legacy-docs.helloclever.co](https://legacy-docs.helloclever.co).","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"ja","banner":{"content":"現在ご覧いただいているのは、新しい Hello Clever ドキュメントサイトです。旧ドキュメントは [legacy-docs.helloclever.co](https://legacy-docs.helloclever.co) をご覧ください。","dismissible":true},"navbar":{"links":[{"href":"https://support.helloclever.co/merchant-knowledge-base","label":"サポート"}],"primary":{"type":"button","label":"Merchant Portal","href":"https://merchant.helloclever.co"}},"href":"ja"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"helloclever-8a6f7f0c","hasAudioNarration":false,"actualSubdomain":"helloclever-8a6f7f0c","customDomains":["docs.helloclever.co"],"gitSource":{"type":"github","owner":"hello-clever-pty","repo":"mintlify-helloclever","deployBranch":"production","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae995d6804cbf9422663c40","collectionId":"fbbc2a71-32b4-479c-9372-f0cacd56aefe","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae995d6804cbf9422663c40"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae995d6804cbf9422663c40","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":85},{"language":"default","tag":"Payment APIs","count":70},{"language":"en","tag":"Platform Overview","count":57},{"language":"ja","tag":"プラットフォーム概要","count":57},{"language":"default","tag":"v2 (Multi-Currency)","count":39},{"language":"en","tag":"Payment Concepts","count":26},{"language":"ja","tag":"決済の基礎","count":26},{"language":"default","tag":"v1 (AUD)","count":26},{"language":"en","tag":"Developers Reference","count":23},{"language":"ja","tag":"開発者リファレンス","count":23},{"language":"en","tag":"API Reference","count":16},{"language":"ja","tag":"API リファレンス","count":16},{"language":"en","tag":"Clever Concepts","count":12},{"language":"ja","tag":"Clever Concepts","count":12},{"language":"en","tag":"Getting Started","count":10},{"language":"ja","tag":"はじめに","count":10},{"language":"default","tag":"Contact","count":9},{"language":"en","tag":"Payment APIs","count":8},{"language":"en","tag":"Australia","count":8},{"language":"ja","tag":"決済 API","count":8},{"language":"ja","tag":"オーストラリア","count":8},{"language":"default","tag":"AUD PayID","count":8},{"language":"default","tag":"Card API","count":8},{"language":"default","tag":"Cards","count":8},{"language":"en","tag":"Platform Integrations","count":7},{"language":"en","tag":"Merchant Portal","count":7},{"language":"ja","tag":"プラットフォーム連携","count":7},{"language":"ja","tag":"Merchant Portal","count":7},{"language":"default","tag":"AUD Payout","count":6},{"language":"default","tag":"Cashback API","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content-area:has(.hc-page),#body-content:has(.hc-page),.mdx-content:has(.hc-page){padding-left:0!important;padding-right:0!important;max-width:none!important}.hc-page{position:relative;width:100vw;max-width:100vw!important;left:50%;right:50%;margin-left:-50vw!important;margin-right:-50vw!important}.hc-hero::before{content:none!important;background:none!important;-webkit-mask-image:none!important;mask-image:none!important;display:none!important}.hc-page,.hc-hero,.hc-hero-inner,.hc-hero-art{background-image:none!important}.hc-hero{background-color:var(--hc-hero-bg)!important}#navbar div[class*=\"bg-gray-50\"]{background-color:#f5f7fc}.dark #navbar div[class*=\"bg-gray-50\"]{background-color:color-mix(in srgb, #1c1c1e 90%, #ffffff 10%)}#footer a[class*=\"max-w-36\"]{max-width:none!important;overflow:visible!important;text-overflow:clip!important;white-space:normal!important}#footer a[href*=\"utm_campaign=poweredBy\"]{display:none!important}header#header div[class*=\"text-lg\"].prose,header#header div[class*=\"text-lg\"].prose p{font-size:1.0625rem;line-height:1.7;color:rgba(28, 28, 30, 0.62)}.dark header#header div[class*=\"text-lg\"].prose,.dark header#header div[class*=\"text-lg\"].prose p{color:rgba(255, 255, 255, 0.6)}header#header div[class*=\"text-lg\"].prose p:not(:first-of-type){font-size:1rem;line-height:1.75rem}.hc-page{--hc-tint: #f5f7fc;--hc-ink: #1c1c1e;--hc-muted: rgba(28, 28, 30, 0.65);--hc-brand: #004cc9;--hc-brand-strong: color-mix(in srgb, #004cc9 82%, #1c1c1e 18%);--hc-brand-tint: rgba(0, 76, 201, 0.08);--hc-line: rgba(28, 28, 30, 0.09);--hc-card: #ffffff;--hc-shadow: 0 1px 2px rgba(28, 28, 30, 0.05), 0 12px 30px rgba(28, 28, 30, 0.08);--hc-glow: rgba(0, 76, 201, 0.13);--hc-glow-2: rgba(0, 204, 255, 0.09);--hc-hero-bg: #f5f7fc;--hc-grid-line: rgba(0, 76, 201, 0.07);--hc-float-bg: #ffffff;--hc-float-line: rgba(28, 28, 30, 0.07);--hc-float-shadow: 0 10px 24px rgba(28, 28, 30, 0.10), 0 2px 6px rgba(28, 28, 30, 0.06);--hc-chip-bg: #f5f7fc;--hc-chip-line: rgba(28, 28, 30, 0.08);--hc-icon-ink: rgba(28, 28, 30, 0.6);--hc-skel: rgba(28, 28, 30, 0.09);--hc-tag-bg: #fbe58d;--hc-tag-ink: #1c1c1e;--hc-code-ink: rgba(28, 28, 30, 0.42);--hc-code-key: rgba(28, 28, 30, 0.55);--hc-code-str: rgba(0, 76, 201, 0.55);--hc-code-panel-bg: rgba(28, 28, 30, 0.02);--hc-code-panel-line: rgba(28, 28, 30, 0.06);--hc-spark: rgba(0, 76, 201, 0.9);--hc-spark-2: #fbe58d;color:var(--hc-ink)}.dark .hc-page{--hc-tint: rgba(255, 255, 255, 0.04);--hc-ink: #ffffff;--hc-muted: rgba(255, 255, 255, 0.62);--hc-brand: #00ccff;--hc-brand-strong: color-mix(in srgb, #00ccff 80%, #ffffff 20%);--hc-brand-tint: rgba(0, 204, 255, 0.14);--hc-line: rgba(255, 255, 255, 0.12);--hc-card: color-mix(in srgb, #1c1c1e 85%, #ffffff 15%);--hc-shadow: 0 1px 2px rgba(28, 28, 30, 0.4), 0 14px 34px rgba(28, 28, 30, 0.6);--hc-glow: rgba(0, 204, 255, 0.16);--hc-glow-2: rgba(0, 76, 201, 0.14);--hc-hero-bg: #1c1c1e;--hc-grid-line: rgba(255, 255, 255, 0.06);--hc-float-bg: color-mix(in srgb, #1c1c1e 82%, #ffffff 18%);--hc-float-line: rgba(255, 255, 255, 0.08);--hc-float-shadow: 0 14px 34px rgba(28, 28, 30, 0.6), 0 2px 6px rgba(28, 28, 30, 0.5);--hc-chip-bg: rgba(255, 255, 255, 0.06);--hc-chip-line: rgba(255, 255, 255, 0.08);--hc-icon-ink: rgba(255, 255, 255, 0.7);--hc-skel: rgba(255, 255, 255, 0.1);--hc-tag-bg: #fbe58d;--hc-tag-ink: #1c1c1e;--hc-code-ink: rgba(255, 255, 255, 0.34);--hc-code-key: rgba(255, 255, 255, 0.45);--hc-code-str: rgba(0, 204, 255, 0.55);--hc-code-panel-bg: rgba(255, 255, 255, 0.02);--hc-code-panel-line: rgba(255, 255, 255, 0.06);--hc-spark: #00ccff;--hc-spark-2: #fbe58d}.hc-page,.hc-page *,.hc-page *::before{box-sizing:border-box}.hc-wrap{max-width:1120px;margin:0 auto;padding-inline:24px}.hc-hero{position:relative;overflow:hidden;border-bottom:1px solid var(--hc-line);background:var(--hc-hero-bg)}.hc-hero-grid{position:absolute;inset:0;z-index:0;background-image:linear-gradient(to right, var(--hc-grid-line) 1px, transparent 1px),\n linear-gradient(to bottom, var(--hc-grid-line) 1px, transparent 1px);background-size:72px 72px;pointer-events:none;-webkit-mask-image:linear-gradient(100deg, transparent 8%, #000 46%);mask-image:linear-gradient(100deg, transparent 8%, #000 46%)}.hc-hero::after{content:\"\";position:absolute;inset:0;z-index:0;background:radial-gradient(60% 80% at 88% -12%, var(--hc-glow) 0%, transparent 60%),\n radial-gradient(50% 70% at 10% -10%, var(--hc-glow-2) 0%, transparent 60%);pointer-events:none}.hc-hero-inner{position:relative;z-index:1;display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 1fr);align-items:center;gap:32px;padding:clamp(48px, 7vw, 92px) 24px clamp(44px, 6vw, 80px)}.hc-hero-copy{max-width:560px}@media (max-width: 900px){.hc-hero-inner{grid-template-columns:1fr}.hc-hero-art{display:none}}.hc-eyebrow{display:inline-block;font-size:12px;font-weight:600;letter-spacing:0.15em;text-transform:uppercase;color:var(--hc-brand);margin-bottom:20px}.hc-h1{font-size:clamp(34px, 5vw, 58px);line-height:1.03;letter-spacing:-0.03em;font-weight:780;margin:0 0 20px}.hc-h1 .hc-acc{color:var(--hc-brand)}.dark .hc-h1 .hc-acc{color:#00ccff}.hc-sub{font-size:clamp(16px, 1.5vw, 19px);line-height:1.6;color:var(--hc-muted);margin:0 0 32px;max-width:520px}.hc-cta-row{display:flex;flex-wrap:wrap;gap:12px;align-items:center}.hc-quicklinks{display:flex;flex-wrap:wrap;align-items:center;gap:8px 22px;margin-top:28px;font-size:13.5px}.hc-ql-label{font-size:11px;font-weight:600;letter-spacing:0.1em;text-transform:uppercase;color:var(--hc-muted);opacity:0.75}.hc-quicklinks a{color:var(--hc-muted);font-weight:550;text-decoration:none;transition:color 0.14s ease}.hc-quicklinks a:hover{color:var(--hc-brand)}.hc-hero-art{position:relative;min-height:460px;align-self:stretch}.hc-float{position:absolute;background:var(--hc-float-bg);border:1px solid var(--hc-float-line);border-radius:18px;box-shadow:var(--hc-float-shadow);padding:20px}.hc-float-payment{top:10px;left:8%;width:300px;z-index:3}.hc-tag{display:inline-block;background:var(--hc-tag-bg);color:var(--hc-tag-ink);font-size:11px;font-weight:700;letter-spacing:0.08em;text-transform:uppercase;padding:5px 10px;border-radius:7px}.hc-amount{font-size:34px;font-weight:780;letter-spacing:-0.02em;color:var(--hc-ink);margin:14px 0 16px}.hc-skel{display:block;height:10px;border-radius:6px;background:var(--hc-skel)}.hc-skel-lg{width:70%}.hc-skel-sm{width:60%}.hc-skel-row{display:flex;align-items:center;gap:12px;margin-top:18px}.hc-skel-block{width:34px;height:34px;border-radius:9px;background:var(--hc-skel);flex:none}.hc-float-methods{top:232px;left:40%;z-index:4;padding:16px 18px}.hc-method-icons{display:flex;align-items:center;gap:10px}.hc-method-chip{display:inline-flex;align-items:center;justify-content:center;width:38px;height:30px;border-radius:9px;background:var(--hc-chip-bg);border:1px solid var(--hc-chip-line);color:var(--hc-icon-ink)}.hc-method-chip svg{width:18px;height:18px}.hc-method-more{font-size:14px;font-weight:600;color:var(--hc-muted);margin-left:2px}.hc-method-labels{display:flex;gap:10px;margin-top:10px;padding-left:0;font-size:12px;font-weight:600;letter-spacing:0.04em;color:var(--hc-muted)}.hc-method-labels span{width:38px;text-align:center}.hc-float-checkout{top:320px;left:14%;width:300px;z-index:3}.hc-checkout-head{display:flex;align-items:center;gap:10px;margin-bottom:16px}.hc-checkout-ico{display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:9px;background:var(--hc-brand-tint);color:var(--hc-brand)}.hc-checkout-ico svg{width:18px;height:18px}.hc-checkout-title{font-size:16px;font-weight:680;color:var(--hc-ink)}.hc-stat{font-size:15px;color:var(--hc-muted);margin-bottom:8px}.hc-stat strong{font-size:22px;font-weight:780;color:var(--hc-ink);margin-right:6px}.hc-float-checkout .hc-skel{margin-top:10px;width:78%}.hc-code-panel{position:absolute;top:26px;left:82%;right:auto;width:380px;height:380px;padding:28px 26px;border:1px solid var(--hc-code-panel-line);border-radius:16px;background:var(--hc-code-panel-bg);overflow:hidden;z-index:1;pointer-events:none}.hc-code{display:flex;flex-direction:column;gap:8px;font-family:ui-monospace, \"SFMono-Regular\", Menlo, Consolas, monospace;font-size:13.5px;line-height:1.5;color:var(--hc-code-ink);white-space:nowrap}.hc-code-line{padding-left:18px}.hc-code-brace{color:var(--hc-code-ink)}.hc-code-key{color:var(--hc-code-key)}.hc-code-str{color:var(--hc-code-str)}.hc-spark{position:absolute;color:var(--hc-spark);z-index:2}.hc-spark-1{width:15px;height:15px;top:22px;right:22%}.hc-spark-2{width:12px;height:12px;bottom:6px;right:4%;color:var(--hc-spark-2)}.hc-btn{display:inline-flex;align-items:center;gap:8px;font-size:15px;font-weight:600;text-decoration:none;padding:12px 20px;border-radius:10px;transition:transform 0.15s ease, background 0.15s ease, border-color 0.15s ease, color 0.15s ease}.hc-btn svg{width:18px;height:18px}.hc-btn-primary{background:var(--hc-brand);color:#fff}.dark .hc-btn-primary{background:#004cc9;color:#fff}.hc-btn-primary:hover{background:var(--hc-brand-strong);transform:translateY(-1px)}.dark .hc-btn-primary:hover{background:color-mix(in srgb, #004cc9 80%, #1c1c1e 20%)}.hc-btn-ghost{color:var(--hc-ink);border:1px solid var(--hc-line);background:var(--hc-card)}.hc-btn-ghost:hover{border-color:var(--hc-brand);color:var(--hc-brand);transform:translateY(-1px)}.hc-section{padding:clamp(44px, 6vw, 72px) 0 0}.hc-kicker{font-size:13px;font-weight:600;letter-spacing:0.04em;text-transform:uppercase;color:var(--hc-muted);margin:0 0 6px}.hc-lead{font-size:clamp(20px, 2.4vw, 26px);font-weight:640;letter-spacing:-0.02em;margin:0 0 28px}.hc-grid{display:grid;grid-template-columns:repeat(3, 1fr);gap:16px}@media (max-width: 860px){.hc-grid{grid-template-columns:1fr}}.hc-card-link{display:block;text-decoration:none;color:inherit;background:var(--hc-card);border:1px solid var(--hc-line);border-radius:16px;padding:24px;transition:transform 0.16s ease, border-color 0.16s ease, box-shadow 0.16s ease}.hc-card-link:hover{transform:translateY(-3px);border-color:var(--hc-brand);box-shadow:var(--hc-shadow)}.hc-ico{display:inline-flex;align-items:center;justify-content:center;width:40px;height:40px;border-radius:10px;background:var(--hc-brand-tint);color:var(--hc-brand);margin-bottom:16px}.hc-ico svg{width:20px;height:20px}.hc-card-title{font-size:17px;font-weight:640;margin:0 0 6px;display:flex;align-items:center;gap:6px}.hc-card-desc{font-size:14px;line-height:1.55;color:var(--hc-muted);margin:0}.hc-arrow{color:var(--hc-brand);display:inline-flex;transition:transform 0.16s ease}.hc-arrow svg{width:16px;height:16px}.hc-card-link:hover .hc-arrow{transform:translateX(3px)}.hc-lede{margin:20px 0 4px;font-size:15px;line-height:1.6;color:var(--hc-muted)}.hc-lede a{color:var(--hc-brand);font-weight:550;text-decoration:underline;text-decoration-thickness:1px;text-underline-offset:2px}.hc-lede a:hover{text-decoration-thickness:2px}.hc-cards img{display:block;width:100%;aspect-ratio:2 / 1;object-fit:cover}.hc-caps{display:grid;grid-template-columns:repeat(3, 1fr);gap:0 32px;margin-top:4px}@media (max-width: 860px){.hc-caps{grid-template-columns:1fr 1fr}}@media (max-width: 520px){.hc-caps{grid-template-columns:1fr}}.hc-cap{display:flex;align-items:center;justify-content:space-between;padding:16px 2px;text-decoration:none;color:var(--hc-ink);border-bottom:1px solid var(--hc-line);font-size:15px;font-weight:550;transition:color 0.14s ease}.hc-cap:hover{color:var(--hc-brand)}.hc-cap .hc-arrow{opacity:0;transition:opacity 0.14s ease, transform 0.16s ease}.hc-cap:hover .hc-arrow{opacity:1;transform:translateX(3px)}.hc-help{border-top:1px solid var(--hc-line);margin-top:clamp(44px, 6vw, 72px);padding:28px 0 64px;font-size:14px;color:var(--hc-muted)}.hc-help a{color:var(--hc-brand);text-decoration:none;font-weight:600}.hc-help a:hover{text-decoration:underline}@media (prefers-reduced-motion: reduce){.hc-page *,.hc-page *::before,.hc-page *::after{animation:none!important;transition:none!important}}.sidebar-group-header{color:#004cc9!important;font-weight:700!important;font-size:0.875rem!important;line-height:1.25rem!important}.dark .sidebar-group-header{color:#00ccff!important}.sidebar-group-header .sidebar-group-icon{flex:none}li[data-group-tag]>button{font-weight:600}h2{color:#004cc9}.dark h2{color:#ffffff}.hc-footer{background:#1c1c1e;color:rgba(255, 255, 255, 0.92);padding:56px 0 0;margin-top:clamp(44px, 6vw, 72px)}.hc-footer-inner{display:grid;grid-template-columns:minmax(0, 1.4fr) minmax(0, 1fr) minmax(0, 1fr) minmax(0, 0.9fr);gap:40px;padding-bottom:40px}@media (max-width: 900px){.hc-footer-inner{grid-template-columns:1fr 1fr}}@media (max-width: 560px){.hc-footer-inner{grid-template-columns:1fr}}.hc-footer-logo{height:26px;width:auto;display:block;margin-bottom:20px}.hc-footer-ack-text{font-size:13px;line-height:1.55;color:rgba(255, 255, 255, 0.6);max-width:320px;margin:0 0 24px}.hc-footer-badges{display:flex;align-items:center;gap:14px;flex-wrap:wrap}.hc-footer-badges img{height:42px;width:auto;display:block}.hc-footer-col{display:flex;flex-direction:column;gap:14px}.hc-footer-col a{color:rgba(255, 255, 255, 0.75);text-decoration:none;font-size:14px;transition:color 0.14s ease}.hc-footer-col a:hover{color:#ffffff}.hc-footer-social{display:flex;flex-direction:column;gap:16px}.hc-footer-social-icons{display:flex;align-items:center;gap:10px;flex-wrap:wrap}.hc-footer-social-icons a{display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:999px;background:rgba(255, 255, 255, 0.06);transition:background 0.14s ease}.hc-footer-social-icons a:hover{background:rgba(255, 255, 255, 0.14)}.hc-footer-social-icons img{width:16px;height:16px;filter:invert(1)}.hc-footer-apps{display:inline-flex;align-items:center;gap:12px;background:#ffffff;border-radius:999px;padding:10px 18px;width:fit-content}.hc-footer-apps a{display:inline-flex}.hc-footer-apps img{width:18px;height:18px}.hc-footer-apps-divider{width:1px;height:18px;background:rgba(10, 10, 13, 0.15)}.hc-footer-bottom{display:flex;align-items:center;justify-content:space-between;gap:16px;flex-wrap:wrap;border-top:1px solid rgba(255, 255, 255, 0.1);padding:20px 0;font-size:12px;color:rgba(255, 255, 255, 0.55)}.hc-footer-ack-row{display:flex;align-items:center;gap:10px}.hc-footer-ack-row img{height:16px;width:auto;border-radius:2px}.hc-footer-copyright{margin:0}.hc-badge-row{display:flex;flex-wrap:wrap;gap:8px;margin:16px 0 24px}.hc-badge{display:inline-flex;align-items:center;gap:6px;padding:4px 11px;border-radius:999px;border:1px solid rgba(28, 28, 30, 0.12);background:rgba(28, 28, 30, 0.04);color:rgba(28, 28, 30, 0.72);font-size:12px;font-weight:600;line-height:1.5;letter-spacing:0.01em;white-space:nowrap}.dark .hc-badge{border-color:rgba(255, 255, 255, 0.14);background:rgba(255, 255, 255, 0.06);color:rgba(255, 255, 255, 0.76)}.hc-badge-brand{border-color:rgba(0, 76, 201, 0.22);background:rgba(0, 76, 201, 0.08);color:#004cc9}.dark .hc-badge-brand{border-color:rgba(0, 204, 255, 0.28);background:rgba(0, 204, 255, 0.12);color:#00ccff}.hc-badge-accent{border-color:rgba(251, 229, 141, 0.9);background:rgba(251, 229, 141, 0.35);color:#6b5300}.dark .hc-badge-accent{border-color:rgba(251, 229, 141, 0.4);background:rgba(251, 229, 141, 0.16);color:#fbe58d}"}],"page":{"pagePath":"api/contact/submit-kyc","slug":"/api/contact/submit-kyc","pageMetadata":{"title":"Submit KYC","description":"This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact's identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact `email`.","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/submit_kyc","href":"/api/contact/submit-kyc","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact’s identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact \", _jsx(_components.code, {\n children: \"email\"\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":"Submit KYC","description":"This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact's identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact `email`.","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/submit_kyc","href":"/api/contact/submit-kyc","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/helloclever-8a6f7f0c/918bcc6581b71e23/serve.js"],"openApiReferenceData":{"operation":{"tags":["Contact"],"summary":"Submit KYC","description":"This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact's identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact `email`.","requestBody":"a635072a-dd26-4384-8ff1-804faf39d75c","responses":{"200":"8e1cf09b-8146-49ed-bc3c-955bd02ed890","400":"5bcaa08e-4755-4683-bfb9-a2529087d141","401":"bbe6cc92-9f3d-47b9-991a-e90b30670f83","422":"1db9b2c4-5f76-43a7-bb40-1eaa3f959418"},"callbacks":{"KYCStatusChanged":"c82faf59-673e-4339-8944-99c84c59a806"},"method":"post","type":"path","servers":["e4513cfc-df5b-4f7e-aad1-d2e90d9c3d90","c11b1f36-0206-487d-bf54-b86c4b95331c"],"security":["264f42eb-b8cb-4957-96db-2fc43cad3dbb"],"path":"/v2/contacts/submit_kyc","baseUrlOptions":["https://api.cleverhub.co/api","https://api-merchant.helloclever.co/api"],"title":"Submit KYC","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["email","document_type","document_number","document_username","expiry_date","issue_country","nationality","selfie","id_doc_front_side","id_doc_back_side","webhook_notification"],"properties":{"email":{"type":"string","description":"The contact's email used for verification.","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"document_type":{"type":"string","description":"The type of identification document (e.g., passport, id_card).","enum":["passport","id_card","driving_license"],"isRequired":true,"uniqueKey":"document_type","typeLabel":"enum\u003cstring>"},"document_number":{"type":"string","description":"The identification number on the document.","isRequired":true,"uniqueKey":"document_number","typeLabel":"string"},"document_username":{"type":"string","description":"The name as shown on the identification document.","isRequired":true,"uniqueKey":"document_username","typeLabel":"string"},"expiry_date":{"type":"string","description":"The expiry date of the identification document in format 'yyyy-mm-dd'.","isRequired":true,"uniqueKey":"expiry_date","typeLabel":"string"},"issue_country":{"type":"string","description":"The country that issued the identification document (ISO 3166-1 alpha-2).","isRequired":true,"uniqueKey":"issue_country","typeLabel":"string"},"nationality":{"type":"string","description":"The country of nationality of the contact (ISO 3166-1 alpha-2 code).","isRequired":true,"uniqueKey":"nationality","typeLabel":"string"},"selfie":{"type":"string","format":"binary","description":"A selfie image of the contact for identity verification should be in `JPEG` format.","isRequired":true,"uniqueKey":"selfie","typeLabel":"file"},"id_doc_front_side":{"type":"string","format":"binary","description":"The front side image of the identification document should be in `JPEG` or `PNG` format.","isRequired":true,"uniqueKey":"id_doc_front_side","typeLabel":"file"},"id_doc_back_side":{"type":"string","format":"binary","description":"The back side image of the identification document should be in `JPEG` or `PNG` format.","isRequired":true,"uniqueKey":"id_doc_back_side","typeLabel":"file"},"webhook_notification":{"type":"object","description":"Merchant Callback Details","required":["endpoint_url","authorization_header"],"properties":{"endpoint_url":{"type":"string","format":"url (endpoint_url)","example":"https://example.org","description":"An internet accessible url which Hello Clever will invoke when the status of the transaction has changed. The call will be done using the HTTP POST method. The endpoint exposed by the client must be TLS 1.2 and the server certificate must be issued by a well known commercial certificate authority and that self-signed or internally signed certs are not acceptable.","isRequired":true,"uniqueKey":"webhook_notification.endpoint_url","typeLabel":"string\u003curl (endpoint_url)>"},"authorization_header":{"type":"string","format":"(authorization_header)","example":"SECRET","description":"The string which Hello Clever will put into the Authorization request header when calling the Callback url.","isRequired":true,"uniqueKey":"webhook_notification.authorization_header","typeLabel":"string\u003c(authorization_header)>"}},"isRequired":true,"uniqueKey":"webhook_notification","typeLabel":"object"},"issue_date":{"type":"string","description":"The issue date of the identification document in format 'yyyy-mm-dd'.","uniqueKey":"issue_date","typeLabel":"string"}},"example":{"email":"test@example.com","document_type":"passport","document_number":"12345678","document_username":"Luyx Tran","issue_date":"2024-04-16","expiry_date":"2024-04-16","issue_country":"AU","nationality":"AU","selfie":"photo.jpeg","id_doc_front_side":"front_side.png","id_doc_back_side":"back_side.png","webhook_notification":{"endpoint_url":"https://yourserver.co/notifications","authorization_header":"****"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"email":"test@example.com","document_type":"passport","document_number":"12345678","document_username":"Luyx Tran","issue_date":"2024-04-16","expiry_date":"2024-04-16","issue_country":"AU","nationality":"AU","selfie":"photo.jpeg","id_doc_front_side":"front_side.png","id_doc_back_side":"back_side.png","webhook_notification":{"endpoint_url":"https://yourserver.co/notifications","authorization_header":"****"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8e1cf09b-8146-49ed-bc3c-955bd02ed890":{"description":"KYC submission successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","uniqueKey":"status","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"Ok"},"examples":{"Example":{"title":"Example","value":{"status":"Ok"}}},"exampleType":"examples"}},"exampleType":"examples"},"5bcaa08e-4755-4683-bfb9-a2529087d141":{"description":"Bad Request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"bbe6cc92-9f3d-47b9-991a-e90b30670f83":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"errors.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.message","typeLabel":"string"}},"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":{"code":"REQUIRE_LOGIN","message":"Not Authorised"}},"examples":{"Example":{"title":"Example","value":{"errors":{"code":"REQUIRE_LOGIN","message":"Not Authorised"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1db9b2c4-5f76-43a7-bb40-1eaa3f959418":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"errors.message","typeLabel":"string"}},"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":{"message":"Email can't be blank"}},"examples":{"Example":{"title":"Example","value":{"errors":{"message":"Email can't be blank"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"callbacks":[{"callbackName":"KYCStatusChanged","expression":"{$request.body#/endpoint_url}","method":"post","resolved":{"operation":{"summary":"KYC Status Changed Event","description":"When the KYC status changes, Hello Clever will call the `endpoint_url` provided in the Submit KYC request. \nThe call will be made using the HTTP POST method.\n\nThe notification will include detailed KYC information for the contact, including the updated status (pending, approved, failed), and other relevant details.\n","parameters":["095ab56f-ba66-4175-b392-00728eed7502"],"requestBody":"b6edb229-0db8-4ac6-9543-5b857de41c90","responses":{"200":"849db1a7-08ca-44cd-b69e-ab95bbabb96d"},"method":"post","type":"path"},"dependencies":{"parameters":{"095ab56f-ba66-4175-b392-00728eed7502":{"in":"header","name":"Authorization","required":true,"schema":{"type":"string","description":"The value of the `Authorization` header will be taken from `authorization_header` in the Submit KYC payload.","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Contact's email","uniqueKey":"email","typeLabel":"string"},"first_name":{"type":"string","description":"Contact's first name","uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Contact's last name","uniqueKey":"last_name","typeLabel":"string"},"type":{"type":"string","description":"The type of contact (e.g., individual or organization)","example":"individual","enum":["individual","organization"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"dob":{"type":"string","description":"Contact date of birth format 'yyyy-mm-dd'","uniqueKey":"dob","typeLabel":"string"},"phone":{"type":"string","description":"Contact's phone","example":"+61-412345678","uniqueKey":"phone","typeLabel":"string"},"reg_no":{"type":"string","description":"Contact registration number.","uniqueKey":"reg_no","typeLabel":"string"},"gender":{"type":"string","example":"male","description":"Contact's gender","enum":["male","female"],"uniqueKey":"gender","typeLabel":"enum\u003cstring>"},"street":{"type":"string","description":"The primary name of an address's street.","uniqueKey":"street","typeLabel":"string"},"city":{"type":"string","description":"Name of an address's city or town.","uniqueKey":"city","typeLabel":"string"},"postal_code":{"type":"string","description":"The address's postcode","uniqueKey":"postal_code","typeLabel":"string"},"state":{"type":"string","description":"The address's state / province / county.","uniqueKey":"state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","uniqueKey":"country","typeLabel":"string"},"identity":{"type":"object","description":"Contains the most recent KYC submission details for the contact.","properties":{"issue_country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","uniqueKey":"identity.issue_country","typeLabel":"string"},"id_doc_type":{"type":"string","description":"Type of identification document","enum":["passport","id_card","driving_license"],"uniqueKey":"identity.id_doc_type","typeLabel":"enum\u003cstring>"},"document_number":{"type":"string","description":"ID document number","uniqueKey":"identity.document_number","typeLabel":"string"},"issue_date":{"type":"string","description":"Format 'yyyy-mm-dd'","uniqueKey":"identity.issue_date","typeLabel":"string"},"expiry_date":{"type":"string","description":"Format 'yyyy-mm-dd'","uniqueKey":"identity.expiry_date","typeLabel":"string"}},"uniqueKey":"identity","typeLabel":"object"},"kyc_statuses":{"type":"array","description":"An array of KYC statuses for the contact, containing multiple KYC instances with status and message.","items":{"type":"object","properties":{"kyc_status":{"type":"string","description":"- `pending`: KYC process has been initiated for the contact, but the verification is not yet completed. The contact is still in the process of submitting the necessary documents.\n- `failed`: contact was unable to verify the KYC documents due to invalid, incomplete, or unclear information. The contact may need to resubmit the documents.\n- `rejected`: KYC has been rejected for future transactions due to failure in meeting the required verification criteria. The contact cannot proceed with any further transactions until the issue is resolved.\n- `manual_review`: The KYC process is under review by the compliance team to approve or reject the documents. This status typically means that the submitted documents need further examination.\n- `blocked`: Contact's KYC has been blocked, preventing future transactions until further resolution. The block may be due to suspicious activity or a need for additional verification.\n- `approved`: Contact has successfully passed the KYC verification, and future transactions can proceed without issue. The contact's identity has been verified and is now compliant with the platform's standards.","enum":["pending","failed","rejected","manual_review","blocked","approved"],"uniqueKey":"kyc_statuses.items.[INDEX].kyc_status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Message related to the KYC status","uniqueKey":"kyc_statuses.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"kyc_statuses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"kyc_statuses","typeLabel":"object[]"}},"example":{"email":"test@example.com","first_name":"Luyx","last_name":"Tran","type":"individual","dob":"1991-12-24","phone":"+6123224242","reg_no":"123456789","gender":"male","street":"338 George Street","city":"Sydney","postal_code":"2000","state":"New South Wales","country":"AU","identity":{"issue_country":"AU","document_number":"12345678","issue_date":"2024-04-16","expiry_date":"2024-04-16","id_doc_type":"Passport"},"kyc_statuses":[{"kyc_status":"approved","message":"null"},{"kyc_status":"rejected","message":"KYC is rejected."}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"email":"test@example.com","first_name":"Luyx","last_name":"Tran","type":"individual","dob":"1991-12-24","phone":"+6123224242","reg_no":"123456789","gender":"male","street":"338 George Street","city":"Sydney","postal_code":"2000","state":"New South Wales","country":"AU","identity":{"issue_country":"AU","document_number":"12345678","issue_date":"2024-04-16","expiry_date":"2024-04-16","id_doc_type":"Passport"},"kyc_statuses":[{"kyc_status":"approved","message":"null"},{"kyc_status":"rejected","message":"KYC is rejected."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"849db1a7-08ca-44cd-b69e-ab95bbabb96d":{"description":"The merchant's server should return this code","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{}}}}],"security":{"264f42eb-b8cb-4957-96db-2fc43cad3dbb":{"app-id":{"type":"apiKey","in":"header","name":"app-id","description":"A unique identifier assigned to each application.\n","scopes":[],"schemeName":"app-id"},"secret-key":{"type":"apiKey","in":"header","name":"secret-key","description":"A secure token associated with the `app-id`.\n","scopes":[],"schemeName":"secret-key"}}},"servers":{"e4513cfc-df5b-4f7e-aad1-d2e90d9c3d90":{"url":"https://api.cleverhub.co/api","description":"Sandbox Environment"},"c11b1f36-0206-487d-bf54-b86c4b95331c":{"url":"https://api-merchant.helloclever.co/api","description":"Production Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"app-id","description":"A unique identifier assigned to each application.\n","scopes":[],"schemeName":"app-id"},"schema":{"title":"app-id","type":"string","description":"A unique identifier assigned to each application.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"app-id","name":"app-id"},{"scheme":{"type":"apiKey","in":"header","name":"secret-key","description":"A secure token associated with the `app-id`.\n","scopes":[],"schemeName":"secret-key"},"schema":{"title":"secret-key","type":"string","description":"A secure token associated with the `app-id`.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"secret-key","name":"secret-key"}],"title":"app-id \u0026 secret-key"}]},"originalFileLocation":"api/openapi/v2-reference.yaml"},"subdomain":"helloclever-8a6f7f0c","siteName":"Hello Clever","title":"Hello Clever Developer Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api/contact/submit-kyc","matchLevel":0},"ja":{"href":"/api/contact/submit-kyc","matchLevel":0}}},"lastModified":"2026-11-03T08:05:54.047Z","originalFileLocation":"api/contact/submit-kyc.mdx","locale":"en"},"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=\"This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact\u0026#x27;s identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact email.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hello Clever\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Hello Clever Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Guides and API references for Hello Clever\u0026#x27;s multi-currency payment gateway, card, and cashback APIs, plus Clever AI tools for merchants and developers.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hello Clever\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.helloclever.co/api/contact/submit-kyc\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.helloclever.co/images/og-img-doc-site.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=\"Hello Clever Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Guides and API references for Hello Clever\u0026#x27;s multi-currency payment gateway, card, and cashback APIs, plus Clever AI tools for merchants and developers.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.helloclever.co/images/og-img-doc-site.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/helloclever-8a6f7f0c/p87PhmFXYoczo7mg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hello Clever\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#004CC9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.helloclever.co/api/contact/submit-kyc\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/contact/submit-kyc.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.helloclever.co/#organization\",\"name\":\"Hello Clever\",\"url\":\"https://docs.helloclever.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/helloclever-8a6f7f0c/S7QMDoXOC49VUXaT/hello-clever-logo-light.svg?fit=max\u0026auto=format\u0026n=S7QMDoXOC49VUXaT\u0026q=85\u0026s=4a928e1c744ef4dedb8b8afff710d1ac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.helloclever.co#website\",\"name\":\"Hello Clever\",\"url\":\"https://docs.helloclever.co\",\"publisher\":{\"@id\":\"https://docs.helloclever.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.helloclever.co/api/contact/submit-kyc#webpage\",\"url\":\"https://docs.helloclever.co/api/contact/submit-kyc\",\"name\":\"Submit KYC\",\"description\":\"This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact's identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact email.\",\"dateModified\":\"2026-11-03T08:05:54.047Z\",\"isPartOf\":{\"@id\":\"https://docs.helloclever.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.helloclever.co/api/contact/submit-kyc#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.helloclever.co/api/contact/submit-kyc#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payment APIs\",\"item\":\"https://docs.helloclever.co/api/v1/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"v2 (Multi-Currency)\",\"item\":\"https://docs.helloclever.co/api/v2/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Contact\",\"item\":\"https://docs.helloclever.co/api/contact/create-contact\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Submit KYC\",\"item\":\"https://docs.helloclever.co/api/contact/submit-kyc\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.helloclever.co/api/contact/submit-kyc#apireference\",\"headline\":\"Submit KYC\",\"name\":\"Submit KYC\",\"description\":\"This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact's identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact email.\",\"url\":\"https://docs.helloclever.co/api/contact/submit-kyc\",\"mainEntityOfPage\":{\"@id\":\"https://docs.helloclever.co/api/contact/submit-kyc#webpage\"},\"image\":\"https://docs.helloclever.co/images/og-img-doc-site.png\",\"dateModified\":\"2026-11-03T08:05:54.047Z\",\"publisher\":{\"@id\":\"https://docs.helloclever.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.helloclever.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hello Clever\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hello Clever","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/getting-started/overview"}]},{"tab":"Platform Overview","pages":[{"title":"Platform Overview","href":"/platform-overview/overview"}]},{"tab":"Developers Reference","pages":[{"title":"Developers Reference","href":"/integrations/choosing-integration"}]},{"tab":"API Reference","groups":[{"group":"Basics","icon":"book-open","pages":[{"title":"Hello Clever API Overview","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Authenticate with the Hello Clever API","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"Webhooks: Real-time Payment Notifications","sidebarTitle":"Webhooks","href":"/api/webhooks"}]},{"group":"Payment APIs","icon":"money-bill-transfer","pages":[{"group":"v1 (AUD)","icon":"money-bill-wave","pages":[{"title":"Payment APIs for AUD","sidebarTitle":"Introduction","href":"/api/v1/introduction"},{"title":"AUD Balance API Reference","href":"/api/v1/balance"},{"title":"Simulate Deposit API Reference","sidebarTitle":"Simulate Deposit","href":"/api/v1/simulate-deposit"},{"group":"Balance","pages":[{"title":"Get Balance Details","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/balances/detail","href":"/api/balance/get-balance-details"},{"title":"Get Balance History","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/balances/history","href":"/api/balance/get-balance-history"}]},{"group":"Payment Gateway","pages":[{"title":"Generate Access Token","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_gateways/access_token","href":"/api/payment-gateway/generate-access-token"},{"title":"Create Payment Gateway Link","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payment_gateways/create_payment","href":"/api/payment-gateway/create-payment-gateway-link"}]},{"group":"AUD PayID","pages":[{"title":"Create One-Time PayID","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/merchants/create_payment","href":"/api/aud-payid/create-one-time-payid"},{"title":"Create Static PayID","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/customers/create_static_open_payid","href":"/api/aud-payid/create-static-payid"},{"title":"Get PayID Status","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/status","href":"/api/aud-payid/get-payid-status"},{"title":"Get Static PayID List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/customers/get_static_open_payids","href":"/api/aud-payid/get-static-payid-list"},{"title":"Refund Payment","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payment_requests/refund","href":"/api/aud-payid/refund-payment"},{"title":"Cancel a PayID","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payment_requests/cancel_payid","href":"/api/aud-payid/cancel-a-payid"},{"title":"Get Payment Request List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests","href":"/api/aud-payid/get-payment-request-list"},{"title":"Get Payment Request Statistics","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/count","href":"/api/aud-payid/get-payment-request-statistics"}]},{"group":"AUD BSB/Account Number","pages":[{"title":"Create BSB/Account Number Payment","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/merchants/create_bank_payment","href":"/api/aud-bsbaccount-number/create-bsbaccount-number-payment"},{"title":"Get Payment Request List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/bank_payments","href":"/api/aud-bsbaccount-number/get-payment-request-list"},{"title":"Get Payment Request Status","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/bank_payments_status","href":"/api/aud-bsbaccount-number/get-payment-request-status"}]},{"group":"AUD PayTo","pages":[{"title":"Create Payment Agreement","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/pay_to/payment_agreement","href":"/api/aud-payto/create-payment-agreement"},{"title":"Amend Payment Agreement","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/pay_to/payment_agreement/amendment","href":"/api/aud-payto/amend-payment-agreement"},{"title":"Change Payment Agreement Status","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/pay_to/payment_agreement/change_status","href":"/api/aud-payto/change-payment-agreement-status"},{"title":"Get Payment Agreement Detail","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/pay_to/payment_agreement/detail","href":"/api/aud-payto/get-payment-agreement-detail"},{"title":"Get Payment Agreements","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/pay_to/payment_agreement/search","href":"/api/aud-payto/get-payment-agreements"}]},{"group":"AUD Payout","pages":[{"title":"Create a Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts","href":"/api/aud-payout/create-a-payout"},{"title":"Get Payout List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payouts/","href":"/api/aud-payout/get-payout-list"},{"title":"Create Payout Batch via File","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts/","href":"/api/aud-payout/create-payout-batch-via-file"},{"title":"Cancel Scheduled Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts/cancel_scheduled","href":"/api/aud-payout/cancel-scheduled-payout"},{"title":"Get Payout Detail","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payouts/detail","href":"/api/aud-payout/get-payout-detail"},{"title":"Create KYC for Beneficiary","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts/create_kyc","href":"/api/aud-payout/create-kyc-for-beneficiary"}]},{"group":"Cashback","pages":[{"title":"Get Cashback Campaign List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/campaigns","href":"/api/cashback/get-cashback-campaign-list"},{"title":"Get Campaign Configurations","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/configuration_campaign","href":"/api/cashback/get-campaign-configurations"},{"title":"Activate User's Cashback Account","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/activate","href":"/api/cashback/activate-users-cashback-account"},{"title":"Initiate Cashback Delivery","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/deliver","href":"/api/cashback/initiate-cashback-delivery"},{"title":"Initiate Cashback Withdrawal","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/withdraw","href":"/api/cashback/initiate-cashback-withdrawal"},{"title":"Get User List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/users","href":"/api/cashback/get-user-list"}]}]},{"group":"v2 (Multi-Currency)","icon":"money-bill-1-wave","pages":[{"title":"Multi-Currency Payment API","sidebarTitle":"Introduction","href":"/api/v2/introduction"},{"title":"Multi-Currency Payin API Reference","href":"/api/v2/payin"},{"title":"Multi-Currency Payout API Reference","href":"/api/v2/payout"},{"title":"Balance API Reference","href":"/api/v2/balance"},{"group":"Balance","pages":[{"title":"Get Balance Details V2","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/balances/detail","href":"/api/balance/get-balance-details-v2"},{"title":"Get Balance History V2","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/balances/history","href":"/api/balance/get-balance-history-v2"}]},{"group":"Payin Methods","pages":[{"title":"Get Payin Methods","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payins/payin_methods","href":"/api/payin-methods/get-payin-methods"},{"title":"Get Payin’s Required Fields","deprecated":null,"version":null,"sidebarTitle":"Get payins required fields","openapi":"/api/openapi/v2-reference.yaml get /v2/payins/payin_method/params","href":"/api/payin-methods/get-payins-required-fields"}]},{"group":"Platform Fee","pages":[{"title":"Get Allocation Recipient Accounts","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/merchant_allocation_profiles/accounts","href":"/api/platform-fee/get-allocation-recipient-accounts"}]},{"group":"Payin","pages":[{"title":"Create a Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins","href":"/api/payin/create-a-payin"},{"title":"Get Payin Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payins/all","href":"/api/payin/get-payin-requests-in-a-period-of-time"},{"title":"Get Payin Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payins/detail","href":"/api/payin/get-payin-details"},{"title":"Payin Request Simulation","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/simulate","href":"/api/payin/payin-request-simulation"},{"title":"Refund Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/refund","href":"/api/payin/refund-payin"},{"title":"Cancel Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/cancel","href":"/api/payin/cancel-payin"}]},{"group":"Mobile Money","pages":[{"title":"Authorizing an OTP transaction","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/confirm_otp","href":"/api/mobile-money/authorizing-an-otp-transaction"},{"title":"Resend OTP","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/resend_otp","href":"/api/mobile-money/resend-otp"},{"title":"Authorizing an STK transaction(Sandbox only)","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/authorize_stk","href":"/api/mobile-money/authorizing-an-stk-transactionsandbox-only"},{"title":"Resend STK (Sim toolkit)","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/resend_stk","href":"/api/mobile-money/resend-stk-sim-toolkit"}]},{"group":"VA Bank Transfer","pages":[{"title":"Authorising OTP transaction","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/bank/confirm_otp","href":"/api/va-bank-transfer/authorising-otp-transaction"},{"title":"Revoke Virtual Account","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml delete /v2/payins/bank/virtual_account","href":"/api/va-bank-transfer/revoke-virtual-account"}]},{"group":"Payout Methods","pages":[{"title":"Get Payout Methods","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/payout_methods","href":"/api/payout-methods/get-payout-methods"},{"title":"Get Payout Required Fields","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/payout_method/params","href":"/api/payout-methods/get-payout-required-fields"}]},{"group":"Payout","pages":[{"title":"Create a Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payouts","href":"/api/payout/create-a-payout"},{"title":"Get Payout Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/all","href":"/api/payout/get-payout-requests-in-a-period-of-time"},{"title":"Get Payout Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/detail","href":"/api/payout/get-payout-details"},{"title":"Payout Simulation","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payouts/simulate","href":"/api/payout/payout-simulation"},{"title":"Cancel a Scheduled Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payouts/cancel_scheduled","href":"/api/payout/cancel-a-scheduled-payout"},{"title":"Get Branch Codes","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/branch_codes","href":"/api/payout/get-branch-codes"}]},{"group":"Customer","pages":[{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/customers","href":"/api/customer/create-customer"},{"title":"Get Customer Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/customers/all","href":"/api/customer/get-customer-requests-in-a-period-of-time"},{"title":"Get Customer Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/customers/detail","href":"/api/customer/get-customer-details"}]},{"group":"Contact","pages":[{"title":"Create Contact","description":"When processing a `Payin` or `Payout` transaction, if the `require_contact` parameter is `true`, you need to create a new contact before proceeding with the transaction. Each contact will have a unique email associated with it, ensuring that the user’s information is complete before continuing with the payment process. This email will be used during the process of calling the API to create a `Payin` or `Payout` transaction.\n\nAfter successfully creating the contact, you need to perform `KYC (Know Your Customer)` verification for this contact if the `Payin` or `Payout` methods require KYC(`require_kyc == true`). This will be done through the `Submit KYC API` provided below. If KYC is not required, you can proceed with the transaction process without further verification. Ensure that these steps are completed thoroughly and accurately to maintain security and compliance. Wishing you success in carrying out this process!","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts","href":"/api/contact/create-contact"},{"title":"Submit KYC","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/submit_kyc","href":"/api/contact/submit-kyc"},{"title":"Generate Share Token Using Sumsub API","description":"Contact Hello Clever Support team to get `Sumsub` Client ID.\n\nSee the `Sumsub` Authentication documentation (https://docs.sumsub.com/reference/authentication) to add the required headers to the `Sumsub` API request.\n","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /resources/accessTokens/shareToken","href":"/api/contact/generate-share-token-using-sumsub-api"},{"title":"Submit KYC With Token","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/share_token","href":"/api/contact/submit-kyc-with-token"},{"title":"Resend Contact Verification","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/resend_verification","href":"/api/contact/resend-contact-verification"},{"title":"Update Contact (Deprecated)","deprecated":true,"version":null,"openapi":"/api/openapi/v2-reference.yaml put /v2/contact/update_info","href":"/api/contact/update-contact-deprecated"},{"title":"Get Contact Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/contacts/all","href":"/api/contact/get-contact-requests-in-a-period-of-time"},{"title":"Get Contact Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/contacts/detail","href":"/api/contact/get-contact-details"},{"title":"Delete Contact (Deprecated)","deprecated":true,"version":null,"openapi":"/api/openapi/v2-reference.yaml delete /v2/contacts/delete","href":"/api/contact/delete-contact-deprecated"}]},{"group":"Bank Lookup (VND only)","pages":[{"title":"Lookup via QR Content","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/banks/lookup/qr_content","href":"/api/bank-lookup-vnd-only/lookup-via-qr-content"},{"title":"Lookup via QR Image","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/banks/lookup/qr_image","href":"/api/bank-lookup-vnd-only/lookup-via-qr-image"}]}]},{"group":"Payment Gateway 3","icon":"globe","pages":[{"title":"Payment Gateway 3 API","sidebarTitle":"Introduction","href":"/api/v3/introduction"},{"group":"PayIn","pages":[{"title":"Get PayIn methods","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml get /v3/payin_methods","href":"/api/gateway3/payin/get-payin-methods"},{"title":"List PayIns","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml get /v3/payin_links","href":"/api/gateway3/payin/list-payins"},{"title":"Create PayIn","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml post /v3/payin_links","href":"/api/gateway3/payin/create-payin"},{"title":"Get PayIn details","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml get /v3/payin_links/{uuid}","href":"/api/gateway3/payin/get-payin-details"},{"title":"Refund Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml post /v3/payin_links/refund","href":"/api/gateway3/payin/refund-payin"}]}]}]},{"group":"Card API","icon":"credit-card","pages":[{"title":"Card Payment API Overview","sidebarTitle":"Overview","href":"/api/card/overview"},{"title":"Card JavaScript SDK integration","sidebarTitle":"SDK integration","href":"/api/card/sdk-integration"},{"group":"Cards","pages":[{"title":"Create Payment via Card Information (S2S)","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/charges","href":"/api/cards/create-payment-via-card-information-s2s"},{"title":"Create Payment via Tokenisation","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/create_payment","href":"/api/cards/create-payment-via-tokenisation"},{"title":"Capture Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/capture_payment","href":"/api/cards/capture-payment"},{"title":"Void Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/void_payment","href":"/api/cards/void-payment"},{"title":"Refund Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/refund_payment","href":"/api/cards/refund-payment"},{"title":"Delete Token","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml delete /v2/cards/{token_id}","href":"/api/cards/delete-token"},{"title":"List Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml get /v2/cards/payments","href":"/api/cards/list-payment"},{"title":"Detail Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml get /v2/cards/payments/{uuid}","href":"/api/cards/detail-payment"}]}]},{"group":"Cashback API","icon":"gift","pages":[{"title":"Cashback API Overview","sidebarTitle":"Overview","href":"/api/cashback/overview"},{"group":"Cashback","pages":[{"title":"Get Cashback Campaign List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/campaigns","href":"/api/cashback/get-cashback-campaign-list"},{"title":"Get Campaign Configurations","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/configuration_campaign","href":"/api/cashback/get-campaign-configurations"},{"title":"Activate User's Cashback Account","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/activate","href":"/api/cashback/activate-users-cashback-account"},{"title":"Initiate Cashback Delivery","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/deliver","href":"/api/cashback/initiate-cashback-delivery"},{"title":"Initiate Cashback Withdrawal","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/withdraw","href":"/api/cashback/initiate-cashback-withdrawal"},{"title":"Get User List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/users","href":"/api/cashback/get-user-list"}]}]},{"group":"Reporting API","icon":"file-lines","pages":[{"title":"Reporting API Overview","sidebarTitle":"Overview","href":"/api/reporting/overview"},{"title":"Settlement Reporting","sidebarTitle":"Settlement","href":"/api/reporting/settlement"},{"group":"Reporting","pages":[{"title":"Get Settlement Reports","deprecated":null,"version":null,"openapi":"/api/openapi/reporting-reference.yaml get /v2/reports/settlements","href":"/api/reporting/get-settlement-reports"}]}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes"}]}]},{"language":"ja","banner":{"content":"現在ご覧いただいているのは、新しい Hello Clever ドキュメントサイトです。旧ドキュメントは [legacy-docs.helloclever.co](https://legacy-docs.helloclever.co) をご覧ください。","dismissible":true},"navbar":{"links":[{"href":"https://support.helloclever.co/merchant-knowledge-base","label":"サポート"}],"primary":{"type":"button","label":"Merchant Portal","href":"https://merchant.helloclever.co"}},"tabs":[{"tab":"ホーム","icon":"house","pages":[{"title":"ホーム","href":"/ja"}]},{"tab":"はじめに","pages":[{"title":"はじめに","href":"/ja/getting-started/overview"}]},{"tab":"プラットフォーム概要","pages":[{"title":"プラットフォーム概要","href":"/ja/platform-overview/overview"}]},{"tab":"開発者リファレンス","pages":[{"title":"開発者リファレンス","href":"/ja/integrations/choosing-integration"}]},{"tab":"API リファレンス","groups":[{"group":"基本","icon":"book-open","pages":[{"title":"Hello Clever API の概要","sidebarTitle":"概要","href":"/ja/api/overview"},{"title":"Hello Clever API の認証","sidebarTitle":"認証","href":"/ja/api/authentication"},{"title":"Webhook:リアルタイムの決済通知","sidebarTitle":"Webhook","href":"/ja/api/webhooks"}]},{"group":"決済 API","icon":"money-bill-transfer","pages":[{"group":"v1 (AUD)","icon":"money-bill-wave","pages":[{"title":"AUD 向け決済 API","sidebarTitle":"はじめに","href":"/ja/api/v1/introduction"},{"title":"AUD 残高 API リファレンス","href":"/ja/api/v1/balance"},{"title":"入金シミュレーション API リファレンス","sidebarTitle":"入金シミュレーション","href":"/ja/api/v1/simulate-deposit"},{"group":"Balance","pages":[{"title":"Get Balance Details","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/balances/detail","href":"/api/balance/get-balance-details"},{"title":"Get Balance History","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/balances/history","href":"/api/balance/get-balance-history"}]},{"group":"Payment Gateway","pages":[{"title":"Generate Access Token","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_gateways/access_token","href":"/api/payment-gateway/generate-access-token"},{"title":"Create Payment Gateway Link","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payment_gateways/create_payment","href":"/api/payment-gateway/create-payment-gateway-link"}]},{"group":"AUD PayID","pages":[{"title":"Create One-Time PayID","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/merchants/create_payment","href":"/api/aud-payid/create-one-time-payid"},{"title":"Create Static PayID","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/customers/create_static_open_payid","href":"/api/aud-payid/create-static-payid"},{"title":"Get PayID Status","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/status","href":"/api/aud-payid/get-payid-status"},{"title":"Get Static PayID List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/customers/get_static_open_payids","href":"/api/aud-payid/get-static-payid-list"},{"title":"Refund Payment","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payment_requests/refund","href":"/api/aud-payid/refund-payment"},{"title":"Cancel a PayID","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payment_requests/cancel_payid","href":"/api/aud-payid/cancel-a-payid"},{"title":"Get Payment Request List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests","href":"/api/aud-payid/get-payment-request-list"},{"title":"Get Payment Request Statistics","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/count","href":"/api/aud-payid/get-payment-request-statistics"}]},{"group":"AUD BSB/Account Number","pages":[{"title":"Create BSB/Account Number Payment","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/merchants/create_bank_payment","href":"/api/aud-bsbaccount-number/create-bsbaccount-number-payment"},{"title":"Get Payment Request List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/bank_payments","href":"/api/aud-bsbaccount-number/get-payment-request-list"},{"title":"Get Payment Request Status","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payment_requests/bank_payments_status","href":"/api/aud-bsbaccount-number/get-payment-request-status"}]},{"group":"AUD PayTo","pages":[{"title":"Create Payment Agreement","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/pay_to/payment_agreement","href":"/api/aud-payto/create-payment-agreement"},{"title":"Amend Payment Agreement","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/pay_to/payment_agreement/amendment","href":"/api/aud-payto/amend-payment-agreement"},{"title":"Change Payment Agreement Status","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/pay_to/payment_agreement/change_status","href":"/api/aud-payto/change-payment-agreement-status"},{"title":"Get Payment Agreement Detail","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/pay_to/payment_agreement/detail","href":"/api/aud-payto/get-payment-agreement-detail"},{"title":"Get Payment Agreements","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/pay_to/payment_agreement/search","href":"/api/aud-payto/get-payment-agreements"}]},{"group":"AUD Payout","pages":[{"title":"Create a Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts","href":"/api/aud-payout/create-a-payout"},{"title":"Get Payout List","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payouts/","href":"/api/aud-payout/get-payout-list"},{"title":"Create Payout Batch via File","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts/","href":"/api/aud-payout/create-payout-batch-via-file"},{"title":"Cancel Scheduled Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts/cancel_scheduled","href":"/api/aud-payout/cancel-scheduled-payout"},{"title":"Get Payout Detail","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml get /v1/payouts/detail","href":"/api/aud-payout/get-payout-detail"},{"title":"Create KYC for Beneficiary","deprecated":null,"version":null,"openapi":"/api/openapi/v1-reference.yaml post /v1/payouts/create_kyc","href":"/api/aud-payout/create-kyc-for-beneficiary"}]},{"group":"Cashback","pages":[{"title":"Get Cashback Campaign List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/campaigns","href":"/api/cashback/get-cashback-campaign-list"},{"title":"Get Campaign Configurations","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/configuration_campaign","href":"/api/cashback/get-campaign-configurations"},{"title":"Activate User's Cashback Account","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/activate","href":"/api/cashback/activate-users-cashback-account"},{"title":"Initiate Cashback Delivery","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/deliver","href":"/api/cashback/initiate-cashback-delivery"},{"title":"Initiate Cashback Withdrawal","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/withdraw","href":"/api/cashback/initiate-cashback-withdrawal"},{"title":"Get User List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/users","href":"/api/cashback/get-user-list"}]}]},{"group":"v2 (Multi-Currency)","icon":"money-bill-1-wave","pages":[{"title":"Multi-Currency Payment API","sidebarTitle":"はじめに","href":"/ja/api/v2/introduction"},{"title":"多通貨 Payin API リファレンス","href":"/ja/api/v2/payin"},{"title":"多通貨 Payout API リファレンス","href":"/ja/api/v2/payout"},{"title":"残高 API リファレンス","href":"/ja/api/v2/balance"},{"group":"Balance","pages":[{"title":"Get Balance Details V2","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/balances/detail","href":"/api/balance/get-balance-details-v2"},{"title":"Get Balance History V2","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/balances/history","href":"/api/balance/get-balance-history-v2"}]},{"group":"Payin Methods","pages":[{"title":"Get Payin Methods","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payins/payin_methods","href":"/api/payin-methods/get-payin-methods"},{"title":"Get Payin’s Required Fields","deprecated":null,"version":null,"sidebarTitle":"Get payins required fields","openapi":"/api/openapi/v2-reference.yaml get /v2/payins/payin_method/params","href":"/api/payin-methods/get-payins-required-fields"}]},{"group":"Platform Fee","pages":[{"title":"Get Allocation Recipient Accounts","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/merchant_allocation_profiles/accounts","href":"/api/platform-fee/get-allocation-recipient-accounts"}]},{"group":"Payin","pages":[{"title":"Create a Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins","href":"/api/payin/create-a-payin"},{"title":"Get Payin Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payins/all","href":"/api/payin/get-payin-requests-in-a-period-of-time"},{"title":"Get Payin Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payins/detail","href":"/api/payin/get-payin-details"},{"title":"Payin Request Simulation","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/simulate","href":"/api/payin/payin-request-simulation"},{"title":"Refund Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/refund","href":"/api/payin/refund-payin"},{"title":"Cancel Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/cancel","href":"/api/payin/cancel-payin"}]},{"group":"Mobile Money","pages":[{"title":"Authorizing an OTP transaction","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/confirm_otp","href":"/api/mobile-money/authorizing-an-otp-transaction"},{"title":"Resend OTP","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/resend_otp","href":"/api/mobile-money/resend-otp"},{"title":"Authorizing an STK transaction(Sandbox only)","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/authorize_stk","href":"/api/mobile-money/authorizing-an-stk-transactionsandbox-only"},{"title":"Resend STK (Sim toolkit)","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/resend_stk","href":"/api/mobile-money/resend-stk-sim-toolkit"}]},{"group":"VA Bank Transfer","pages":[{"title":"Authorising OTP transaction","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payins/bank/confirm_otp","href":"/api/va-bank-transfer/authorising-otp-transaction"},{"title":"Revoke Virtual Account","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml delete /v2/payins/bank/virtual_account","href":"/api/va-bank-transfer/revoke-virtual-account"}]},{"group":"Payout Methods","pages":[{"title":"Get Payout Methods","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/payout_methods","href":"/api/payout-methods/get-payout-methods"},{"title":"Get Payout Required Fields","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/payout_method/params","href":"/api/payout-methods/get-payout-required-fields"}]},{"group":"Payout","pages":[{"title":"Create a Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payouts","href":"/api/payout/create-a-payout"},{"title":"Get Payout Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/all","href":"/api/payout/get-payout-requests-in-a-period-of-time"},{"title":"Get Payout Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/detail","href":"/api/payout/get-payout-details"},{"title":"Payout Simulation","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payouts/simulate","href":"/api/payout/payout-simulation"},{"title":"Cancel a Scheduled Payout","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/payouts/cancel_scheduled","href":"/api/payout/cancel-a-scheduled-payout"},{"title":"Get Branch Codes","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/payouts/branch_codes","href":"/api/payout/get-branch-codes"}]},{"group":"Customer","pages":[{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/customers","href":"/api/customer/create-customer"},{"title":"Get Customer Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/customers/all","href":"/api/customer/get-customer-requests-in-a-period-of-time"},{"title":"Get Customer Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/customers/detail","href":"/api/customer/get-customer-details"}]},{"group":"Contact","pages":[{"title":"Create Contact","description":"When processing a `Payin` or `Payout` transaction, if the `require_contact` parameter is `true`, you need to create a new contact before proceeding with the transaction. Each contact will have a unique email associated with it, ensuring that the user’s information is complete before continuing with the payment process. This email will be used during the process of calling the API to create a `Payin` or `Payout` transaction.\n\nAfter successfully creating the contact, you need to perform `KYC (Know Your Customer)` verification for this contact if the `Payin` or `Payout` methods require KYC(`require_kyc == true`). This will be done through the `Submit KYC API` provided below. If KYC is not required, you can proceed with the transaction process without further verification. Ensure that these steps are completed thoroughly and accurately to maintain security and compliance. Wishing you success in carrying out this process!","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts","href":"/api/contact/create-contact"},{"title":"Submit KYC","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/submit_kyc","href":"/api/contact/submit-kyc"},{"title":"Generate Share Token Using Sumsub API","description":"Contact Hello Clever Support team to get `Sumsub` Client ID.\n\nSee the `Sumsub` Authentication documentation (https://docs.sumsub.com/reference/authentication) to add the required headers to the `Sumsub` API request.\n","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /resources/accessTokens/shareToken","href":"/api/contact/generate-share-token-using-sumsub-api"},{"title":"Submit KYC With Token","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/share_token","href":"/api/contact/submit-kyc-with-token"},{"title":"Resend Contact Verification","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/contacts/resend_verification","href":"/api/contact/resend-contact-verification"},{"title":"Update Contact (Deprecated)","deprecated":true,"version":null,"openapi":"/api/openapi/v2-reference.yaml put /v2/contact/update_info","href":"/api/contact/update-contact-deprecated"},{"title":"Get Contact Requests in a Period of Time","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/contacts/all","href":"/api/contact/get-contact-requests-in-a-period-of-time"},{"title":"Get Contact Details","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml get /v2/contacts/detail","href":"/api/contact/get-contact-details"},{"title":"Delete Contact (Deprecated)","deprecated":true,"version":null,"openapi":"/api/openapi/v2-reference.yaml delete /v2/contacts/delete","href":"/api/contact/delete-contact-deprecated"}]},{"group":"Bank Lookup (VND only)","pages":[{"title":"Lookup via QR Content","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/banks/lookup/qr_content","href":"/api/bank-lookup-vnd-only/lookup-via-qr-content"},{"title":"Lookup via QR Image","deprecated":null,"version":null,"openapi":"/api/openapi/v2-reference.yaml post /v2/banks/lookup/qr_image","href":"/api/bank-lookup-vnd-only/lookup-via-qr-image"}]}]},{"group":"Payment Gateway 3","icon":"globe","pages":[{"title":"Payment Gateway 3 API","sidebarTitle":"はじめに","href":"/ja/api/v3/introduction"},{"group":"PayIn","pages":[{"title":"Get PayIn methods","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml get /v3/payin_methods","href":"/api/gateway3/payin/get-payin-methods"},{"title":"List PayIns","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml get /v3/payin_links","href":"/api/gateway3/payin/list-payins"},{"title":"Create PayIn","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml post /v3/payin_links","href":"/api/gateway3/payin/create-payin"},{"title":"Get PayIn details","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml get /v3/payin_links/{uuid}","href":"/api/gateway3/payin/get-payin-details"},{"title":"Refund Payin","deprecated":null,"version":null,"openapi":"/api/openapi/v3-reference.yaml post /v3/payin_links/refund","href":"/api/gateway3/payin/refund-payin"}]}]}]},{"group":"Card API","icon":"credit-card","pages":[{"title":"カード決済 API の概要","sidebarTitle":"概要","href":"/ja/api/card/overview"},{"title":"カード JavaScript SDK の連携","sidebarTitle":"SDK 連携","href":"/ja/api/card/sdk-integration"},{"group":"Cards","pages":[{"title":"Create Payment via Card Information (S2S)","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/charges","href":"/api/cards/create-payment-via-card-information-s2s"},{"title":"Create Payment via Tokenisation","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/create_payment","href":"/api/cards/create-payment-via-tokenisation"},{"title":"Capture Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/capture_payment","href":"/api/cards/capture-payment"},{"title":"Void Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/void_payment","href":"/api/cards/void-payment"},{"title":"Refund Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml post /v2/cards/refund_payment","href":"/api/cards/refund-payment"},{"title":"Delete Token","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml delete /v2/cards/{token_id}","href":"/api/cards/delete-token"},{"title":"List Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml get /v2/cards/payments","href":"/api/cards/list-payment"},{"title":"Detail Payment","deprecated":null,"version":null,"openapi":"/api/openapi/card-reference.yaml get /v2/cards/payments/{uuid}","href":"/api/cards/detail-payment"}]}]},{"group":"Cashback API","icon":"gift","pages":[{"title":"Cashback API の概要","sidebarTitle":"概要","href":"/ja/api/cashback/overview"},{"group":"Cashback","pages":[{"title":"Get Cashback Campaign List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/campaigns","href":"/api/cashback/get-cashback-campaign-list"},{"title":"Get Campaign Configurations","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/configuration_campaign","href":"/api/cashback/get-campaign-configurations"},{"title":"Activate User's Cashback Account","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/activate","href":"/api/cashback/activate-users-cashback-account"},{"title":"Initiate Cashback Delivery","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/deliver","href":"/api/cashback/initiate-cashback-delivery"},{"title":"Initiate Cashback Withdrawal","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml post /v2/cashbacks/withdraw","href":"/api/cashback/initiate-cashback-withdrawal"},{"title":"Get User List","deprecated":null,"version":null,"openapi":"/api/openapi/cashback-reference.yaml get /v2/cashbacks/users","href":"/api/cashback/get-user-list"}]}]},{"group":"Reporting API","icon":"file-lines","pages":[{"title":"Reporting API の概要","sidebarTitle":"概要","href":"/ja/api/reporting/overview"},{"title":"精算レポート","sidebarTitle":"精算","href":"/ja/api/reporting/settlement"},{"group":"Reporting","pages":[{"title":"Get Settlement Reports","deprecated":null,"version":null,"openapi":"/api/openapi/reporting-reference.yaml get /v2/reports/settlements","href":"/api/reporting/get-settlement-reports"}]}]}]},{"tab":"リリースノート","pages":[{"title":"リリースノート","href":"/ja/release-notes"}]}]}]},"basePath":"","title":"Hello Clever Developer Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-DicSZcaX.js","dist-CIQkMg3R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-ClVdStUn.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BAvA99GL.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","AssistantPageLink-ImrFS4Fy.js"]}