Requires scope:manage:parties — see Required scopes.Returns where the party’s verification stands — KYC for an INDIVIDUAL, KYB for an ORGANISATION — read live from the verification platform. Use it to tell a verification that is under review apart from one that is waiting on your end customer, and to see which step needs attention.
Field
What it tells you
verificationState
The headline: AWAITING_CUSTOMER, IN_REVIEW, RESUBMISSION_REQUESTED, APPROVED or DECLINED.
requiredAction
What the end customer still has to do — for example COMPLETE_SUMSUB_VERIFICATION. Omitted when nothing is required.
steps
The review outcome per step, with rejectLabels explaining a rejection and itemIds listing questionnaire items that still need attention.
caseStatus
The underlying case status, for support conversations.
lastSyncedAt
When the state was last synchronised with the verification provider.
This endpoint reports progress, not the verdict you branch on. The party’s and its accounts’ kycStatus/kybStatus change only once a verdict (APPROVED or DECLINED) is reached — read those from Get a party.
New values may be added to every enum-like field. Treat an unknown verificationState as still in progress.
Which tenant the request is scoped to, among those your token grants. Omit it when the token
grants exactly one tenant; it is required when the token grants more than one. A supplied
value must exactly match a tenant the token grants.
Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets
the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones
you may use. Send the header once: a repeated header is rejected the same way.
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Path Parameters
partyId
string<uuid>
required
Unique party identifier
Response
Where the party's verification stands
success
boolean
Indicates whether the request was successful
result
object
Where a party's identity verification stands, relayed live from the verification platform.
Enum-like values are relayed as-is and new values may be added; treat an unknown
verificationState as still in progress.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Venly Finance","colors":{"primary":"#e07826","light":"#f0a060","dark":"#c56820"},"logo":{"light":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb","dark":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/dark_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=3bafc93202007edf53e789ed58bc7002","href":"https://venlyfinance.com"},"favicon":"https://mintcdn.com/venly/MUxny2c1OXcZxLbW/logo/favicon_logo.png?fit=max\u0026auto=format\u0026n=MUxny2c1OXcZxLbW\u0026q=85\u0026s=892dd58ed49fe804011fcf42f60f82d4","api":{"playground":{"display":"interactive"}},"navbar":{"primary":{"type":"button","label":"Venly","href":"https://venlyfinance.com"}},"footer":{"socials":{"x":"https://x.com/Venly_io","linkedin":"https://be.linkedin.com/company/venly-io"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"venly","hasAudioNarration":false,"actualSubdomain":"venly","customDomains":["docs.venlyfinance.com"],"gitSource":{"type":"github","owner":"venly","repo":"mintlify-api-docs-main","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afaea070c14fe3987666c1e","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Finance API","count":98},{"language":"default","tag":"Fundflow API","count":45},{"language":"default","tag":"Parties","count":13},{"language":"default","tag":"Core Concepts","count":13},{"language":"default","tag":"Ramp Requests","count":12},{"language":"default","tag":"Overview","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Onboarding \u0026 Verification","count":9},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Getting Started","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/Finance-API/parties/get-a-partys-kyc-status","slug":"/api-reference/Finance-API/parties/get-a-partys-kyc-status","pageMetadata":{"title":"Get a party's KYC status","description":"See where a party's KYC or KYB verification stands, and what the end customer still has to do.","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/kyc-status","href":"/api-reference/Finance-API/parties/get-a-partys-kyc-status"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"See where a party’s KYC or KYB verification stands, and what the end customer still has to do.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Requires scope:`}),` `,_jsx(_components.code,{children:`manage:parties`}),` — see `,_jsx(_components.a,{href:`/getting-started/authentication#required-scopes-finance-api`,children:`Required scopes`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Returns where the party’s verification stands — KYC for an `,_jsx(_components.code,{children:`INDIVIDUAL`}),`, KYB for an `,_jsx(_components.code,{children:`ORGANISATION`}),` — read live from the verification platform. Use it to tell a verification that is `,_jsx(_components.strong,{children:`under review`}),` apart from one that is `,_jsx(_components.strong,{children:`waiting on your end customer`}),`, and to see which step needs attention.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`What it tells you`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`verificationState`})}),_jsxs(_components.td,{children:[`The headline: `,_jsx(_components.code,{children:`AWAITING_CUSTOMER`}),`, `,_jsx(_components.code,{children:`IN_REVIEW`}),`, `,_jsx(_components.code,{children:`RESUBMISSION_REQUESTED`}),`, `,_jsx(_components.code,{children:`APPROVED`}),` or `,_jsx(_components.code,{children:`DECLINED`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`requiredAction`})}),_jsxs(_components.td,{children:[`What the end customer still has to do — for example `,_jsx(_components.code,{children:`COMPLETE_SUMSUB_VERIFICATION`}),`. Omitted when nothing is required.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`steps`})}),_jsxs(_components.td,{children:[`The review outcome per step, with `,_jsx(_components.code,{children:`rejectLabels`}),` explaining a rejection and `,_jsx(_components.code,{children:`itemIds`}),` listing questionnaire items that still need attention.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`caseStatus`})}),_jsx(_components.td,{children:`The underlying case status, for support conversations.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`lastSyncedAt`})}),_jsx(_components.td,{children:`When the state was last synchronised with the verification provider.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`verificationState`}),` is `,_jsx(_components.code,{children:`AWAITING_CUSTOMER`}),`, `,_jsx(_components.a,{href:`/api-reference/Finance-API/parties/issue-a-kyc-completion-link`,children:`issue a KYC completion link`}),` and hand it to your end customer.`]}),`\n`,_jsxs(Note,{children:[`This endpoint reports `,_jsx(_components.strong,{children:`progress`}),`, not the verdict you branch on. The party’s and its accounts’ `,_jsx(_components.code,{children:`kycStatus`}),`/`,_jsx(_components.code,{children:`kybStatus`}),` change only once a verdict (`,_jsx(_components.code,{children:`APPROVED`}),` or `,_jsx(_components.code,{children:`DECLINED`}),`) is reached — read those from `,_jsx(_components.a,{href:`/api-reference/Finance-API/parties/get-party-details`,children:`Get a party`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`New values may be added to every enum-like field. Treat an unknown `,_jsx(_components.code,{children:`verificationState`}),` as still in progress.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP`}),_jsx(_components.th,{children:_jsx(_components.code,{children:`code`})}),_jsx(_components.th,{children:`When`}),_jsx(_components.th,{children:`Retry?`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`party-not-found`})}),_jsx(_components.td,{children:`No such party for your company`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`No`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`kyc-status-not-found`})}),_jsx(_components.td,{children:`The party has no verification on record yet`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`No`}),` — start one with a `,_jsx(_components.a,{href:`/api-reference/Finance-API/parties/create-a-verification-link`,children:`verification link`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`identity-verification-rejected`})}),_jsx(_components.td,{children:`Verification refused the request`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`No`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`identity-verification-unavailable`})}),_jsx(_components.td,{children:`Platform unreachable`}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Yes`}),`, with backoff`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/guides/finance/onboarding/troubleshooting`,children:`Troubleshooting verification`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a party's KYC status","description":"See where a party's KYC or KYB verification stands, and what the end customer still has to do.","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/kyc-status","href":"/api-reference/Finance-API/parties/get-a-partys-kyc-status"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Parties"],"summary":"Get a party's KYC status","description":"See where a party's KYC or KYB verification stands, and what the end customer still has to do.","operationId":"getPartyKycStatus","parameters":["1a2056ea-2571-4228-b637-3d7b7014f03b"],"responses":{"200":"21ab6431-30b0-4414-bceb-8bac8cd80675","401":"142cfb68-10a1-4799-baf2-fb3771a1c794","403":"81aac327-afc0-46ae-8bba-5ee19d8aa5d0","404":"ff265a05-f9ac-4f68-879d-cc84d339eb56","500":"60371b70-f330-49e1-b914-e7b2acd6e428","503":"d5e55603-1a12-4fbf-af26-cb437df34d7d"},"method":"get","type":"path","servers":["7ccd99be-e28d-4721-9a67-da99d4352b21","9f7a6158-6efa-486c-991d-4d69199ecde2"],"security":["0e3ba47e-a570-40d0-b3e6-688cb37506b4"],"path":"/parties/{partyId}/kyc-status","baseUrlOptions":["https://api.venlyfinance.com/v1","https://api-staging.venlyfinance.com/v1"],"title":"Get a party's KYC status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1a2056ea-2571-4228-b637-3d7b7014f03b":{"name":"partyId","in":"path","required":true,"description":"Unique party identifier","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Unique party identifier","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22"},"7df0e1f8-bdd8-452d-ad56-fe5d3a5dcb84":{"name":"x-tenant-id","in":"header","required":false,"description":"Which tenant the request is scoped to, among those your token grants. Omit it when the token\ngrants exactly one tenant; it is **required** when the token grants more than one. A supplied\nvalue must exactly match a tenant the token grants.\n\nAbsent when required, blank, malformed, or naming a tenant the token does not grant — each gets\nthe same generic `403 forbidden`, which reveals neither whether a tenant exists nor which ones\nyou may use. Send the header once: a repeated header is rejected the same way.\n","schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","isRequired":false,"description":"Which tenant the request is scoped to, among those your token grants. Omit it when the token\ngrants exactly one tenant; it is **required** when the token grants more than one. A supplied\nvalue must exactly match a tenant the token grants.\n\nAbsent when required, blank, malformed, or naming a tenant the token does not grant — each gets\nthe same generic `403 forbidden`, which reveals neither whether a tenant exists nor which ones\nyou may use. Send the header once: a repeated header is rejected the same way.\n","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"21ab6431-30b0-4414-bceb-8bac8cd80675":{"description":"Where the party's verification stands","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful","uniqueKey":"success","typeLabel":"boolean"},"result":{"type":"object","description":"Where a party's identity verification stands, relayed live from the verification platform.\nEnum-like values are relayed as-is and new values may be added; treat an unknown\n`verificationState` as still in progress.\n","required":["partyId","verificationState","steps"],"properties":{"partyId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"result.partyId","typeLabel":"string\u003cuuid>"},"verificationState":{"type":"string","description":"- `AWAITING_CUSTOMER` — the end customer still has to act (see `requiredAction`)\n- `IN_REVIEW` — submitted and under review\n- `RESUBMISSION_REQUESTED` — the reviewer asked the customer to resubmit part of the verification\n- `APPROVED` — verified; the party and its accounts are updated accordingly\n- `DECLINED` — verification failed; the party and its accounts are updated accordingly\n\nNew values may be added; treat an unknown value as still in progress.\n","example":"AWAITING_CUSTOMER","isRequired":true,"uniqueKey":"result.verificationState","typeLabel":"string"},"steps":{"type":"array","description":"Review outcome per step; empty when no step detail is available.","items":{"type":"object","required":["step","status","rejectLabels","itemIds"],"properties":{"step":{"type":"string","description":"The verification step.","example":"IDENTITY","isRequired":true,"uniqueKey":"result.steps.items.[INDEX].step","typeLabel":"string"},"status":{"type":"string","description":"The step's review outcome: `NOT_SUBMITTED`, `SUBMITTED`, `APPROVED`, `REJECTED`, `MISSING`\nor `INVALID`. New values may be added.\n","example":"REJECTED","isRequired":true,"uniqueKey":"result.steps.items.[INDEX].status","typeLabel":"string"},"rejectLabels":{"type":"array","description":"Why the step was rejected; empty when it was not.","items":{"type":"string","uniqueKey":"result.steps.items.[INDEX].rejectLabels.items.[INDEX]","typeLabel":"string"},"example":["DOCUMENT_EXPIRED"],"isRequired":true,"uniqueKey":"result.steps.items.[INDEX].rejectLabels","typeLabel":"string[]"},"itemIds":{"type":"array","description":"Questionnaire items that still need attention; empty when none.","items":{"type":"string","uniqueKey":"result.steps.items.[INDEX].itemIds.items.[INDEX]","typeLabel":"string"},"example":["annual_gross_income_band"],"isRequired":true,"uniqueKey":"result.steps.items.[INDEX].itemIds","typeLabel":"string[]"}},"uniqueKey":"result.steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"result.steps","typeLabel":"object[]"},"caseStatus":{"type":"string","description":"The underlying verification case status: `DRAFT`, `SUBMITTED`, `IN_REVIEW`, `APPROVED`,\n`DECLINED` or `NEEDS_INFO`. New values may be added.\n","example":"IN_REVIEW","uniqueKey":"result.caseStatus","typeLabel":"string"},"requiredAction":{"type":"string","description":"What the end customer still has to do; omitted when nothing is required.","example":"COMPLETE_SUMSUB_VERIFICATION","uniqueKey":"result.requiredAction","typeLabel":"string"},"lastSyncedAt":{"type":"string","format":"date-time","description":"When the state was last synchronised with the verification provider; omitted if never.","uniqueKey":"result.lastSyncedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"result","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"result":{"partyId":"7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22","verificationState":"AWAITING_CUSTOMER","caseStatus":"IN_REVIEW","requiredAction":"COMPLETE_SUMSUB_VERIFICATION","steps":[{"step":"IDENTITY","status":"REJECTED","rejectLabels":["DOCUMENT_EXPIRED"],"itemIds":[]}],"lastSyncedAt":"2026-07-14T09:12:44Z"}},"examples":{"Example":{"title":"Example","value":{"success":true,"result":{"partyId":"7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22","verificationState":"AWAITING_CUSTOMER","caseStatus":"IN_REVIEW","requiredAction":"COMPLETE_SUMSUB_VERIFICATION","steps":[{"step":"IDENTITY","status":"REJECTED","rejectLabels":["DOCUMENT_EXPIRED"],"itemIds":[]}],"lastSyncedAt":"2026-07-14T09:12:44Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"142cfb68-10a1-4799-baf2-fb3771a1c794":{"description":"Authentication required or failed (401)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"unauthenticated","message":"Please authenticate to perform this action."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"unauthenticated","message":"Please authenticate to perform this action."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"81aac327-afc0-46ae-8bba-5ee19d8aa5d0":{"description":"Caller lacks the required authority/role (403)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"forbidden","message":"You do not have permission to access this resource."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"forbidden","message":"You do not have permission to access this resource."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"ff265a05-f9ac-4f68-879d-cc84d339eb56":{"description":"- `party-not-found` — the party does not exist or belongs to another company\n- `kyc-status-not-found` — the party has no identity verification on record\n","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"invalid-request","message":"The request contains invalid parameters."}],"result":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"60371b70-f330-49e1-b914-e7b2acd6e428":{"description":"`identity-verification-rejected` — the verification platform rejected the request itself. Not retryable.","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"invalid-request","message":"The request contains invalid parameters."}],"result":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"d5e55603-1a12-4fbf-af26-cb437df34d7d":{"description":"`identity-verification-unavailable` — the verification platform could not be reached. Retry with backoff.","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"invalid-request","message":"The request contains invalid parameters."}],"result":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0e3ba47e-a570-40d0-b3e6-688cb37506b4":{"OAuth2":{"type":"oauth2","description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","flows":{"clientCredentials":{"tokenUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token","scopes":{}}},"scopes":[],"schemeName":"OAuth2"}}},"servers":{"7ccd99be-e28d-4721-9a67-da99d4352b21":{"url":"https://api.venlyfinance.com/v1","description":"Production"},"9f7a6158-6efa-486c-991d-4d69199ecde2":{"url":"https://api-staging.venlyfinance.com/v1","description":"Staging"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","flows":{"clientCredentials":{"tokenUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token","scopes":{}}},"scopes":[],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"api-reference/Finance-API-Specs.yaml"},"subdomain":"venly","siteName":"Venly Finance","title":"Get a party's KYC status - Venly Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T11:33:36.062Z","originalFileLocation":"api-reference/Finance-API/parties/get-a-partys-kyc-status.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"See where a party\u0026#x27;s KYC or KYB verification stands, and what the end customer still has to do.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Venly Finance\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a party\u0026#x27;s KYC status - Venly Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"See where a party\u0026#x27;s KYC or KYB verification stands, and what the end customer still has to do.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Venly Finance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Parties\u0026amp;title=Get+a+party%27s+KYC+status\u0026amp;description=See+where+a+party%27s+KYC+or+KYB+verification+stands%2C+and+what+the+end+customer+still+has+to+do.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=30fd5677234d3eac254a67961b7e160cfcfa8420cc4dcb9abf256c73f618bd67\">\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=\"Get a party\u0026#x27;s KYC status - Venly Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"See where a party\u0026#x27;s KYC or KYB verification stands, and what the end customer still has to do.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Parties\u0026amp;title=Get+a+party%27s+KYC+status\u0026amp;description=See+where+a+party%27s+KYC+or+KYB+verification+stands%2C+and+what+the+end+customer+still+has+to+do.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=30fd5677234d3eac254a67961b7e160cfcfa8420cc4dcb9abf256c73f618bd67\">\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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Venly Finance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e07826\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/Finance-API/parties/get-a-partys-kyc-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.venlyfinance.com/#organization\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.venlyfinance.com#website\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status#webpage\",\"url\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status\",\"name\":\"Get a party's KYC status\",\"description\":\"See where a party's KYC or KYB verification stands, and what the end customer still has to do.\",\"dateModified\":\"2026-11-16T11:33:36.062Z\",\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Parties\",\"item\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/list-all-parties\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a party's KYC status\",\"item\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status#apireference\",\"headline\":\"Get a party's KYC status\",\"name\":\"Get a party's KYC status\",\"description\":\"See where a party's KYC or KYB verification stands, and what the end customer still has to do.\",\"url\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/parties/get-a-partys-kyc-status#webpage\"},\"dateModified\":\"2026-11-16T11:33:36.062Z\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Venly Finance\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Venly Finance\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/Finance-API/parties/get-a-partys-kyc-status.md","siteName":"Venly Finance","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"Fundflow API","pages":[{"title":"Fundflow API","href":"/guides/payments/getting-started"}]},{"tab":"Finance API","groups":[{"group":"Overview","pages":[{"title":"Finance API","sidebarTitle":"Overview","icon":"building-columns","href":"/api-reference/introduction"},{"title":"Data model","icon":"sitemap","href":"/guides/finance/data-model"},{"title":"Getting started","icon":"rocket","href":"/guides/finance/getting-started"},{"title":"Integration Walkthrough","sidebarTitle":"Integration Walkthrough","icon":"route","href":"/guides/finance/integration-walkthrough"},{"title":"Glossary","sidebarTitle":"Glossary","icon":"book-open","href":"/guides/finance/glossary"},{"title":"Countries","icon":"globe-europe","href":"/guides/finance/countries"}]},{"group":"Recipes","pages":[{"title":"Recipe: issue wallets, receive fiat, pay out fiat","sidebarTitle":"Wallet API end-to-end","icon":"book-open","href":"/guides/finance/recipes/wallet-api-end-to-end"}]},{"group":"Onboarding \u0026 Verification","pages":[{"title":"Onboarding lifecycle","sidebarTitle":"Onboarding lifecycle","icon":"route","href":"/guides/finance/onboarding/lifecycle"},{"title":"Roles \u0026 entities","sidebarTitle":"Roles \u0026 entities","icon":"sitemap","href":"/guides/finance/onboarding/roles-and-entities"},{"title":"Individual KYC","sidebarTitle":"Individual KYC","icon":"user","href":"/guides/finance/onboarding/individual-kyc"},{"title":"Business KYB","sidebarTitle":"Business KYB","icon":"building","href":"/guides/finance/onboarding/business-kyb"},{"title":"Hosted verification links","sidebarTitle":"Hosted verification","icon":"link","href":"/guides/finance/onboarding/hosted-verification"},{"title":"Sumsub token sharing","sidebarTitle":"Sumsub token sharing","icon":"forward","href":"/guides/finance/onboarding/sumsub-token-sharing"},{"title":"Partner-terms consent","sidebarTitle":"Partner-terms consent","icon":"file-signature","href":"/guides/finance/onboarding/partner-terms-consent"},{"title":"Partner onboarding","sidebarTitle":"Partner onboarding","icon":"handshake","href":"/guides/finance/onboarding/partner-onboarding"},{"title":"Troubleshooting verification","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/guides/finance/onboarding/troubleshooting"}]},{"group":"Core Concepts","pages":[{"title":"Venly-managed vs self-custody","icon":"key","href":"/guides/finance/managed-vs-self-custody"},{"title":"Account verification","icon":"id-card","href":"/guides/finance/kyc-verification"},{"title":"Wallets \u0026 balances","icon":"wallet","href":"/guides/finance/wallets"},{"title":"Approving transfers without gas","icon":"file-signature","href":"/guides/finance/permits-and-allowances"},{"title":"Transfers","icon":"money-bill-transfer","href":"/guides/finance/transfers"},{"title":"Virtual bank accounts","sidebarTitle":"Virtual bank accounts","icon":"building-columns","href":"/guides/finance/virtual-bank-accounts"},{"title":"Pay-ins","sidebarTitle":"Pay-ins","icon":"arrow-down-to-bracket","href":"/guides/finance/pay-ins"},{"title":"Pay-outs","icon":"money-bill-transfer","href":"/guides/finance/payouts"},{"title":"Webhooks","icon":"bell","href":"/guides/finance/webhooks"},{"title":"API credentials","sidebarTitle":"API credentials","icon":"key","href":"/guides/finance/api-credentials"},{"title":"Billing","sidebarTitle":"Billing","icon":"receipt","href":"/guides/finance/billing"},{"title":"Safe retries with idempotency keys","icon":"arrows-rotate","href":"/guides/finance/idempotency"},{"title":"Versioning \u0026 safe updates","icon":"code-branch","href":"/guides/finance/versioning"}]},{"group":"Parties","pages":[{"title":"List parties","openapi":"api-reference/Finance-API-Specs.yaml GET /parties","href":"/api-reference/Finance-API/parties/list-all-parties"},{"title":"Create a party","openapi":"api-reference/Finance-API-Specs.yaml POST /parties","href":"/api-reference/Finance-API/parties/create-a-new-party"},{"title":"Get a party","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}","href":"/api-reference/Finance-API/parties/get-party-details"},{"title":"Update a party","openapi":"api-reference/Finance-API-Specs.yaml PATCH /parties/{partyId}","href":"/api-reference/Finance-API/parties/update-party-details"},{"title":"Delete a party","openapi":"api-reference/Finance-API-Specs.yaml DELETE /parties/{partyId}","href":"/api-reference/Finance-API/parties/delete-party"},{"title":"Create a verification link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/verification","href":"/api-reference/Finance-API/parties/create-a-verification-link"},{"title":"Get verification linkage","description":"Read a party's verification linkage and its durable case reference.","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/iv-verification","href":"/api-reference/Finance-API/parties/get-verification-linkage"},{"title":"Get a party's KYC status","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/kyc-status","href":"/api-reference/Finance-API/parties/get-a-partys-kyc-status"},{"title":"Issue a KYC completion link","description":"Mint a short-lived link your end customer opens to finish a verification that is waiting on them.","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/kyc-status/completion-link","href":"/api-reference/Finance-API/parties/issue-a-kyc-completion-link"},{"title":"Get partner-terms consent state","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-terms","href":"/api-reference/Finance-API/parties/get-a-partys-partner-terms-consent-state"},{"title":"Issue a partner-terms consent link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/partner-terms/link","href":"/api-reference/Finance-API/parties/issue-a-partner-terms-consent-link"},{"title":"Get a party's partner-onboarding status","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-onboarding","href":"/api-reference/Finance-API/parties/get-a-partys-partner-onboarding-status"},{"title":"Request partner onboarding","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/partner-onboarding","href":"/api-reference/Finance-API/parties/request-partner-onboarding-for-a-party"}]},{"group":"Accounts","pages":[{"title":"List accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts","href":"/api-reference/Finance-API/accounts/list-all-accounts"},{"title":"Create an account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts","href":"/api-reference/Finance-API/accounts/create-a-new-account"},{"title":"Get an account","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}","href":"/api-reference/Finance-API/accounts/get-account-details"},{"title":"List party roles","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/party-roles","href":"/api-reference/Finance-API/accounts/list-party-roles-for-an-account"},{"title":"Add a party role","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/party-roles","href":"/api-reference/Finance-API/accounts/add-a-party-to-an-account"},{"title":"Remove a party role","openapi":"api-reference/Finance-API-Specs.yaml DELETE /accounts/{accountId}/party-roles/{partyId}","href":"/api-reference/Finance-API/accounts/remove-a-party-from-an-account"}]},{"group":"Virtual Bank Accounts","pages":[{"title":"List virtual bank accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/virtual-bank-accounts","href":"/api-reference/Finance-API/virtual-bank-accounts/list-virtual-bank-accounts"},{"title":"Create a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts","href":"/api-reference/Finance-API/virtual-bank-accounts/create-a-virtual-bank-account"},{"title":"Get a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/virtual-bank-accounts/{virtualBankAccountId}","href":"/api-reference/Finance-API/virtual-bank-accounts/get-virtual-bank-account-details"},{"title":"Prepare a wallet-ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts/prepare","href":"/api-reference/Finance-API/virtual-bank-accounts/prepare-a-wallet-ownership-proof"},{"title":"Close a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts/{virtualBankAccountId}/close","href":"/api-reference/Finance-API/virtual-bank-accounts/close-a-virtual-bank-account"}]},{"group":"Supported Assets","pages":[{"title":"List supported assets","openapi":"api-reference/Finance-API-Specs.yaml GET /supported-assets","href":"/api-reference/Finance-API/supported-assets/list-supported-assets"},{"title":"List account supported assets","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/supported-assets","href":"/api-reference/Finance-API/supported-assets/list-account-supported-assets"}]},{"group":"Wallets","pages":[{"title":"List wallets","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets","href":"/api-reference/Finance-API/wallets/list-wallets-for-an-account"}]},{"group":"Transfers","pages":[{"title":"Create a fiat transfer","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{senderAccountId}/transfers/fiat","href":"/api-reference/Finance-API/transfers/create-fiat-transfer"},{"title":"Create a crypto transfer","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{senderAccountId}/transfers/crypto","href":"/api-reference/Finance-API/transfers/create-crypto-transfer"},{"title":"List transfers","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/transfers","href":"/api-reference/Finance-API/transfers/list-transfers-for-account"},{"title":"Get a transfer","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/transfers/{transferId}","href":"/api-reference/Finance-API/transfers/get-transfer-details"}]},{"group":"Fiat to Crypto Payment Sessions","pages":[{"title":"Create a pay-in session","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/fiat-to-crypto/payment-sessions","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/create-a-fiat-to-crypto-payment-session"},{"title":"List pay-in sessions","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/fiat-to-crypto/payment-sessions","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/list-pay-in-sessions"},{"title":"Get a pay-in session","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/fiat-to-crypto/payment-sessions/{sessionId}","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/get-a-pay-in-session"}]},{"group":"Pay-Ins","pages":[{"title":"List pay-ins","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins","href":"/api-reference/Finance-API/pay-ins/list-pay-ins"},{"title":"Get a pay-in","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins/{payInId}","href":"/api-reference/Finance-API/pay-ins/get-a-pay-in"}]},{"group":"Payout Bank Accounts","pages":[{"title":"Register a payout bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/payout-bank-accounts","href":"/api-reference/Finance-API/payout-bank-accounts/register-a-payout-bank-account"},{"title":"List payout bank accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/payout-bank-accounts","href":"/api-reference/Finance-API/payout-bank-accounts/list-payout-bank-accounts"},{"title":"Get a payout bank account","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/payout-bank-accounts/{payoutBankAccountId}","href":"/api-reference/Finance-API/payout-bank-accounts/get-a-payout-bank-account"}]},{"group":"Payout Routes","pages":[{"title":"Create a payout route","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes","href":"/api-reference/Finance-API/payout-routes/create-a-payout-route"},{"title":"List payout routes","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payout-routes","href":"/api-reference/Finance-API/payout-routes/list-payout-routes"},{"title":"Prepare a route ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes/{routeId}/ownership-proof/prepare","href":"/api-reference/Finance-API/payout-routes/prepare-a-route-ownership-proof"},{"title":"Submit a route ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes/{routeId}/ownership-proof/complete","href":"/api-reference/Finance-API/payout-routes/submit-a-route-ownership-proof"}]},{"group":"Payouts","pages":[{"title":"Request a payout","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payouts","href":"/api-reference/Finance-API/payouts/request-a-payout"},{"title":"List payouts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payouts","href":"/api-reference/Finance-API/payouts/list-payouts"},{"title":"Get a payout","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payouts/{payoutId}","href":"/api-reference/Finance-API/payouts/get-a-payout"}]},{"group":"Permits","pages":[{"title":"Get permit messages","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets/{walletId}/permits","href":"/api-reference/Finance-API/permits/get-permit-messages"},{"title":"Submit a signed permit","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/wallets/{walletId}/permits","href":"/api-reference/Finance-API/permits/submit-signed-permit"}]},{"group":"Allowances","pages":[{"title":"Get wallet allowances","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets/{walletId}/allowances","href":"/api-reference/Finance-API/allowances/get-wallet-token-allowances"},{"title":"Verify wallet allowances","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/wallets/{walletId}/allowance-verification","tag":"Coming soon","href":"/api-reference/Finance-API/allowances/verify-wallet-allowances"}]},{"group":"Webhooks","pages":[{"title":"Register a webhook","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks","href":"/api-reference/Finance-API/webhooks/register-a-webhook"},{"title":"List webhooks","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks","href":"/api-reference/Finance-API/webhooks/list-webhooks"},{"title":"Get webhook details","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/get-webhook-details"},{"title":"Update a webhook","openapi":"api-reference/Finance-API-Specs.yaml PUT /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/update-a-webhook"},{"title":"Delete a webhook","openapi":"api-reference/Finance-API-Specs.yaml DELETE /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/delete-a-webhook"},{"title":"Ping a webhook","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks/{webhookId}/ping","href":"/api-reference/Finance-API/webhooks/ping-a-webhook"},{"title":"List webhook deliveries","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}/deliveries","href":"/api-reference/Finance-API/webhooks/list-webhook-deliveries"},{"title":"Get a webhook delivery","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}/deliveries/{deliveryId}","href":"/api-reference/Finance-API/webhooks/get-a-webhook-delivery"},{"title":"Resend a webhook delivery","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks/{webhookId}/deliveries/{deliveryId}/resend","href":"/api-reference/Finance-API/webhooks/resend-a-webhook-delivery"}]},{"group":"API Credentials","pages":[{"title":"List API credentials","openapi":"api-reference/Finance-API-Specs.yaml GET /api-credentials","href":"/api-reference/Finance-API/api-credentials/list-api-credentials"},{"title":"Create API credentials","openapi":"api-reference/Finance-API-Specs.yaml POST /api-credentials","href":"/api-reference/Finance-API/api-credentials/create-api-credentials"},{"title":"Rotate a credential's secret","openapi":"api-reference/Finance-API-Specs.yaml POST /api-credentials/{clientId}/secret","href":"/api-reference/Finance-API/api-credentials/rotate-a-credentials-secret"},{"title":"Enable or disable a credential","openapi":"api-reference/Finance-API-Specs.yaml PUT /api-credentials/{clientId}/status","href":"/api-reference/Finance-API/api-credentials/enable-or-disable-a-credential"}]},{"group":"Billing","pages":[{"title":"List invoices","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices","href":"/api-reference/Finance-API/billing/list-invoices"},{"title":"Get an invoice","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices/{invoiceId}","href":"/api-reference/Finance-API/billing/get-an-invoice"},{"title":"Download an invoice PDF","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices/{invoiceId}/download","href":"/api-reference/Finance-API/billing/download-an-invoice-pdf"}]},{"group":"Company","pages":[{"title":"Get your company profile","openapi":"api-reference/Finance-API-Specs.yaml GET /company","href":"/api-reference/Finance-API/company/get-your-company-profile"}]},{"group":"Reference","pages":[{"title":"Errors \u0026 error codes","sidebarTitle":"Errors","icon":"triangle-exclamation","href":"/guides/finance/errors"},{"title":"Supported chains \u0026 assets","sidebarTitle":"Chains \u0026 assets","icon":"coins","href":"/guides/finance/supported-chains-and-assets"}]}]},{"tab":"Upcoming","pages":[{"title":"Upcoming","href":"/guides/card-issuance/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/guides/finance/changelog"}]}]},"basePath":"","title":"Get a party's KYC status - Venly Finance","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}