Returns the list of pending compliance actions the customer must complete before they are fully verified. Poll this endpoint after registration to know what the customer still needs to do.
Request Headers
string
required
The JWT Access Token of the authenticated user (agent, cashier, or the customer themselves).
string
The userId UUID of the customer whose requirements you want to check. Required when the token belongs to an agent or cashier — without it, the endpoint returns requirements for the token holder, not the customer.
Must be the customer’s userId UUID (e.g. 550e8400-e29b-41d4-a716-446655440000), not their customer code (e.g. VJJGVE).
string
default:"fincode"
required
Platform identifier. Use fincode.
string
default:"200"
required
Unique request identifier.
Query Parameters
string
Alternative way to specify the target customer — the customer’s userId UUID. Either this or X-CUSTOMER-ID can be used; X-CUSTOMER-ID takes precedence if both are provided.
Response
string
SUCCESS or FAILED.
object
Show data fields
string
Inner status string — Success when the call completes.
array
List of pending compliance actions the customer must complete. Empty array means the customer is fully compliant.
Show awaitingComplianceActions item
string
ID of this compliance record. Pass as the path parameter when calling Initiate Compliance Action.
string
The rule ID to include in attachedDocument[].associatedRuleId when uploading documents.
string
The type of action required. Possible values: VERIFY_ACCOUNT_VIA_EMAIL, VERIFY_ACCOUNT_VIA_PHONE_NUMBER, VERIFY_ACCOUNT_VIA_EKYC, VERIFY_ACCOUNT_VIA_EKYC_FACE_PHOTO, VERIFY_ACCOUNT_VIA_EKYC_FACE_VIDEO, VERIFY_ACCOUNT_VIA_IDENTIFICATION_DOCUMENT, CUSTOMER_RISK_ASSESSMENT, THRESHOLD_IDENTIFICATION, THRESHOLD_LIMIT, THRESHOLD_LIMIT_RECEIVING_AMOUNT, THRESHOLD_COUNT_TRANSACTION, LINKED_TRANSACTION, OTHER. See Action Types below.
string
How this requirement restricts the customer. Values: BLOCK (customer cannot proceed until resolved), WARN (customer can proceed but transaction goes to compliance), ALLOW (customer can proceed if within range).
string
Human-readable instruction to display to the customer.
string
The business rule number that triggered this requirement.
string
The screening type. Values: AML, CRA, KYC, EDD, NONE_APPLICABLE.
boolean
true if this action requires a document to be uploaded.
array
List of acceptable document types. Each item has docIdType and docTypeCommonName.
integer
Minimum number of documents from acceptableDocTypes that must be submitted.
string
The eKYC provider integration ID. Present when actionType is VERIFY_ACCOUNT_VIA_EKYC.
string
The eKYC provider code — e.g. SHUFTI_PRO, SEON_IDV, SUMSUB.
string
Dynamic form ID for CRA actions.
array
List of dynamic field IDs associated with the CRA form.
string
The type of data collection form required.
number
Lower bound of the transaction amount range that triggered this rule.
number
Upper bound of the transaction amount range that triggered this rule.
number
The sending amount at the time this rule was evaluated.
string
The compliance result. Values: PASS, WARNING, FAIL.
string
Who this compliance action applies to. Values: CUSTOMER, RECEIVER.
string
Legacy field — the document ID type from the first acceptable doc type.
string
Legacy field — the common name of the first acceptable doc type.
object
Legacy field — single DocIdTypeDTO from the first acceptable doc type.
Action Types
actionType
What it means
What to do
VERIFY_ACCOUNT_VIA_EMAIL
Customer must verify their email
Platform sends a verification email. If doNotForwardEmailVerification is enabled, call Verify Contact with type=EMAIL after verifying on your side.
VERIFY_ACCOUNT_VIA_PHONE_NUMBER
Customer must verify their phone
Platform sends an OTP via SMS. If doNotForwardPhoneVerification is enabled, call Verify Contact with type=PHONE_NUMBER.
CUSTOMER_RISK_ASSESSMENT
Customer must fill a compliance risk assessment form
The customer's userId UUID. Passed by agents or admin users to perform this lookup on behalf of a specific customer.
Query Parameters
userId
string
Filter compliance requirements by this customer's userId.
Response
200 - application/json
Compliance status retrieved successfully
status
string
Example:
"SUCCESS"
message
string
Example:
"Awaiting compliance requirements for Jane Smith ( 447700000001 )"
data
object
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FinCode Platform","colors":{"primary":"#734CDC","light":"#734CDC","dark":"#79359F"},"logo":{"light":"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d","dark":"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d","href":"https://docs.fincode.technology"},"favicon":"https://mintcdn.com/fincode/ryDAHkGMzsGXiEgb/favicon.svg?fit=max\u0026auto=format\u0026n=ryDAHkGMzsGXiEgb\u0026q=85\u0026s=bc4af5ca2aa38e3d5a719288084c0e4e","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Contact Sales","href":"https://fincode.co.uk/contact-us/"}},"footer":{"socials":{"github":"https://github.com/fincodeuk","linkedin":"https://linkedin.com/company/fincodeUk","twitter":"https://twitter.com/fincodehq"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fincode","hasAudioNarration":false,"actualSubdomain":"fincode","customDomains":["docs.fincode.technology"],"gitSource":{"type":"github","owner":"trillionclues-fincode","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af6ff7d565e709b752983ff","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":152},{"language":"default","tag":"Customer Identity \u0026 Access Management","count":59},{"language":"default","tag":"Lending","count":37},{"language":"default","tag":"Remittance","count":26},{"language":"default","tag":"Getting Started","count":17},{"language":"default","tag":"Deposit Engine","count":15},{"language":"default","tag":"Core Flows","count":14},{"language":"default","tag":"Ledger Engine","count":12},{"language":"default","tag":"Songhai Exchange (Payment Switch)","count":12},{"language":"default","tag":"Savings \u0026 Investment","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/ciam/awaiting-compliance-requirements","slug":"/api/ciam/awaiting-compliance-requirements","pageMetadata":{"title":"Awaiting Compliance Requirements","openapi":"GET /compliance/awaiting-compliance-requirements","description":"Returns the outstanding KYC requirements for a customer.","href":"/api/ciam/awaiting-compliance-requirements"},"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: \"Returns the outstanding KYC requirements for a customer.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Returns the list of pending compliance actions the customer must complete before they are fully verified. Poll this endpoint after registration to know what the customer still needs to do.`}),`\n`,_jsx(Heading,{level:`2`,id:`request-headers`,children:`Request Headers`}),`\n`,_jsx(ParamField,{header:`X-Auth-Token`,type:`string`,required:true,id:`param-x-auth-token`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`JWT Access Token`}),` of the authenticated user (agent, cashier, or the customer themselves).`]})}),`\n`,_jsxs(ParamField,{header:`X-CUSTOMER-ID`,type:`string`,id:`param-x-customer-id`,children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`userId`}),` UUID of the customer whose requirements you want to check. Required when the token belongs to an agent or cashier — without it, the endpoint returns requirements for the token holder, not the customer.`]}),_jsx(Warning,{children:_jsxs(_components.p,{children:[`Must be the customer’s `,_jsx(_components.strong,{children:`userId UUID`}),` (e.g. `,_jsx(_components.code,{children:`550e8400-e29b-41d4-a716-446655440000`}),`), not their customer code (e.g. `,_jsx(_components.code,{children:`VJJGVE`}),`).`]})})]}),`\n`,_jsx(ParamField,{header:`platform`,type:`string`,required:true,default:`fincode`,id:`param-platform`,children:_jsxs(_components.p,{children:[`Platform identifier. Use `,_jsx(_components.code,{children:`fincode`}),`.`]})}),`\n`,_jsx(ParamField,{header:`uuid`,type:`string`,required:true,default:`200`,id:`param-uuid`,children:_jsx(_components.p,{children:`Unique request identifier.`})}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query Parameters`}),`\n`,_jsx(ParamField,{query:`userId`,type:`string`,id:`param-user-id`,children:_jsxs(_components.p,{children:[`Alternative way to specify the target customer — the customer’s userId UUID. Either this or `,_jsx(_components.code,{children:`X-CUSTOMER-ID`}),` can be used; `,_jsx(_components.code,{children:`X-CUSTOMER-ID`}),` takes precedence if both are provided.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`SUCCESS`}),` or `,_jsx(_components.code,{children:`FAILED`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`data fields`,children:[_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status-1`,children:_jsxs(_components.p,{children:[`Inner status string — `,_jsx(_components.code,{children:`Success`}),` when the call completes.`]})}),_jsxs(ResponseField,{name:`awaitingComplianceActions`,type:`array`,id:`param-awaiting-compliance-actions`,children:[_jsx(_components.p,{children:`List of pending compliance actions the customer must complete. Empty array means the customer is fully compliant.`}),_jsxs(Expandable,{title:`awaitingComplianceActions item`,children:[_jsx(ResponseField,{name:`customerKycRecordId`,type:`string`,id:`param-customer-kyc-record-id`,children:_jsx(_components.p,{children:`ID of this compliance record. Pass as the path parameter when calling Initiate Compliance Action.`})}),_jsx(ResponseField,{name:`associatedRuleId`,type:`string`,id:`param-associated-rule-id`,children:_jsxs(_components.p,{children:[`The rule ID to include in `,_jsx(_components.code,{children:`attachedDocument[].associatedRuleId`}),` when uploading documents.`]})}),_jsx(ResponseField,{name:`actionType`,type:`string`,id:`param-action-type`,children:_jsxs(_components.p,{children:[`The type of action required. Possible values: `,_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EMAIL`}),`, `,_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_PHONE_NUMBER`}),`, `,_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EKYC`}),`, `,_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EKYC_FACE_PHOTO`}),`, `,_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EKYC_FACE_VIDEO`}),`, `,_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_IDENTIFICATION_DOCUMENT`}),`, `,_jsx(_components.code,{children:`CUSTOMER_RISK_ASSESSMENT`}),`, `,_jsx(_components.code,{children:`THRESHOLD_IDENTIFICATION`}),`, `,_jsx(_components.code,{children:`THRESHOLD_LIMIT`}),`, `,_jsx(_components.code,{children:`THRESHOLD_LIMIT_RECEIVING_AMOUNT`}),`, `,_jsx(_components.code,{children:`THRESHOLD_COUNT_TRANSACTION`}),`, `,_jsx(_components.code,{children:`LINKED_TRANSACTION`}),`, `,_jsx(_components.code,{children:`OTHER`}),`. See Action Types below.`]})}),_jsx(ResponseField,{name:`restrictionLevel`,type:`string`,id:`param-restriction-level`,children:_jsxs(_components.p,{children:[`How this requirement restricts the customer. Values: `,_jsx(_components.code,{children:`BLOCK`}),` (customer cannot proceed until resolved), `,_jsx(_components.code,{children:`WARN`}),` (customer can proceed but transaction goes to compliance), `,_jsx(_components.code,{children:`ALLOW`}),` (customer can proceed if within range).`]})}),_jsx(ResponseField,{name:`customerInstruction`,type:`string`,id:`param-customer-instruction`,children:_jsx(_components.p,{children:`Human-readable instruction to display to the customer.`})}),_jsx(ResponseField,{name:`businessRuleNumber`,type:`string`,id:`param-business-rule-number`,children:_jsx(_components.p,{children:`The business rule number that triggered this requirement.`})}),_jsx(ResponseField,{name:`complianceScreeningType`,type:`string`,id:`param-compliance-screening-type`,children:_jsxs(_components.p,{children:[`The screening type. Values: `,_jsx(_components.code,{children:`AML`}),`, `,_jsx(_components.code,{children:`CRA`}),`, `,_jsx(_components.code,{children:`KYC`}),`, `,_jsx(_components.code,{children:`EDD`}),`, `,_jsx(_components.code,{children:`NONE_APPLICABLE`}),`.`]})}),_jsx(ResponseField,{name:`requestedDocumentUpload`,type:`boolean`,id:`param-requested-document-upload`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`true`}),` if this action requires a document to be uploaded.`]})}),_jsx(ResponseField,{name:`acceptableDocTypes`,type:`array`,id:`param-acceptable-doc-types`,children:_jsxs(_components.p,{children:[`List of acceptable document types. Each item has `,_jsx(_components.code,{children:`docIdType`}),` and `,_jsx(_components.code,{children:`docTypeCommonName`}),`.`]})}),_jsx(ResponseField,{name:`minimumNumberOfAcceptableDocTypes`,type:`integer`,id:`param-minimum-number-of-acceptable-doc-types`,children:_jsxs(_components.p,{children:[`Minimum number of documents from `,_jsx(_components.code,{children:`acceptableDocTypes`}),` that must be submitted.`]})}),_jsx(ResponseField,{name:`ekycProviderId`,type:`string`,id:`param-ekyc-provider-id`,children:_jsxs(_components.p,{children:[`The eKYC provider integration ID. Present when `,_jsx(_components.code,{children:`actionType`}),` is `,_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EKYC`}),`.`]})}),_jsx(ResponseField,{name:`apiProvider`,type:`string`,id:`param-api-provider`,children:_jsxs(_components.p,{children:[`The eKYC provider code — e.g. `,_jsx(_components.code,{children:`SHUFTI_PRO`}),`, `,_jsx(_components.code,{children:`SEON_IDV`}),`, `,_jsx(_components.code,{children:`SUMSUB`}),`.`]})}),_jsx(ResponseField,{name:`craDynamicFormId`,type:`string`,id:`param-cra-dynamic-form-id`,children:_jsx(_components.p,{children:`Dynamic form ID for CRA actions.`})}),_jsx(ResponseField,{name:`craDynamicFieldIds`,type:`array`,id:`param-cra-dynamic-field-ids`,children:_jsx(_components.p,{children:`List of dynamic field IDs associated with the CRA form.`})}),_jsx(ResponseField,{name:`dataCollectionFormType`,type:`string`,id:`param-data-collection-form-type`,children:_jsx(_components.p,{children:`The type of data collection form required.`})}),_jsx(ResponseField,{name:`amountFrom`,type:`number`,id:`param-amount-from`,children:_jsx(_components.p,{children:`Lower bound of the transaction amount range that triggered this rule.`})}),_jsx(ResponseField,{name:`amountTo`,type:`number`,id:`param-amount-to`,children:_jsx(_components.p,{children:`Upper bound of the transaction amount range that triggered this rule.`})}),_jsx(ResponseField,{name:`sendingAmount`,type:`number`,id:`param-sending-amount`,children:_jsx(_components.p,{children:`The sending amount at the time this rule was evaluated.`})}),_jsx(ResponseField,{name:`result`,type:`string`,id:`param-result`,children:_jsxs(_components.p,{children:[`The compliance result. Values: `,_jsx(_components.code,{children:`PASS`}),`, `,_jsx(_components.code,{children:`WARNING`}),`, `,_jsx(_components.code,{children:`FAIL`}),`.`]})}),_jsx(ResponseField,{name:`complianceOn`,type:`string`,id:`param-compliance-on`,children:_jsxs(_components.p,{children:[`Who this compliance action applies to. Values: `,_jsx(_components.code,{children:`CUSTOMER`}),`, `,_jsx(_components.code,{children:`RECEIVER`}),`.`]})}),_jsx(ResponseField,{name:`docIdType`,type:`string`,id:`param-doc-id-type`,children:_jsx(_components.p,{children:`Legacy field — the document ID type from the first acceptable doc type.`})}),_jsx(ResponseField,{name:`docTypeCommonName`,type:`string`,id:`param-doc-type-common-name`,children:_jsx(_components.p,{children:`Legacy field — the common name of the first acceptable doc type.`})}),_jsx(ResponseField,{name:`acceptableDocType`,type:`object`,id:`param-acceptable-doc-type`,children:_jsxs(_components.p,{children:[`Legacy field — single `,_jsx(_components.code,{children:`DocIdTypeDTO`}),` from the first acceptable doc type.`]})})]})]})]})}),`\n`,_jsx(Heading,{level:`2`,id:`action-types`,children:`Action Types`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`actionType`}),_jsx(_components.th,{children:`What it means`}),_jsx(_components.th,{children:`What to do`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EMAIL`})}),_jsx(_components.td,{children:`Customer must verify their email`}),_jsxs(_components.td,{children:[`Platform sends a verification email. If `,_jsx(_components.code,{children:`doNotForwardEmailVerification`}),` is enabled, call `,_jsx(_components.a,{href:`/api/ciam/verify-contact`,children:`Verify Contact`}),` with `,_jsx(_components.code,{children:`type=EMAIL`}),` after verifying on your side.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_PHONE_NUMBER`})}),_jsx(_components.td,{children:`Customer must verify their phone`}),_jsxs(_components.td,{children:[`Platform sends an OTP via SMS. If `,_jsx(_components.code,{children:`doNotForwardPhoneVerification`}),` is enabled, call `,_jsx(_components.a,{href:`/api/ciam/verify-contact`,children:`Verify Contact`}),` with `,_jsx(_components.code,{children:`type=PHONE_NUMBER`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CUSTOMER_RISK_ASSESSMENT`})}),_jsx(_components.td,{children:`Customer must fill a compliance risk assessment form`}),_jsxs(_components.td,{children:[`Call `,_jsx(_components.a,{href:`/api/ciam/initiate-compliance-action`,children:`Initiate Compliance Action`}),` to get the form, then submit via `,_jsx(_components.a,{href:`/api/ciam/submit-cra`,children:`Submit CRA`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`THRESHOLD_IDENTIFICATION`})}),_jsx(_components.td,{children:`Transaction amount threshold triggered — customer must upload an identity document (Passport, Address Proof, or ID)`}),_jsxs(_components.td,{children:[`Call `,_jsx(_components.a,{href:`/api/ciam/initiate-compliance-action`,children:`Initiate Compliance Action`}),`, then `,_jsx(_components.a,{href:`/api/ciam/attach-documents`,children:`Submit KYC Documents`}),` with the `,_jsx(_components.code,{children:`associatedRuleId`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`THRESHOLD_LIMIT`})}),_jsx(_components.td,{children:`Sending amount limit check`}),_jsx(_components.td,{children:`Transaction is blocked until the threshold condition is resolved by the compliance team.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`THRESHOLD_LIMIT_RECEIVING_AMOUNT`})}),_jsx(_components.td,{children:`Receiving amount limit check`}),_jsx(_components.td,{children:`Transaction is blocked until the threshold condition is resolved by the compliance team.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`THRESHOLD_COUNT_TRANSACTION`})}),_jsx(_components.td,{children:`Transaction count limit check`}),_jsx(_components.td,{children:`Transaction is blocked until the threshold condition is resolved.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`LINKED_TRANSACTION`})}),_jsx(_components.td,{children:`Transaction matches a linked-transaction rule (country, name, DOB match)`}),_jsx(_components.td,{children:`Transaction is held pending manual review.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EKYC`})}),_jsx(_components.td,{children:`Customer must complete full eKYC identity verification`}),_jsxs(_components.td,{children:[`Call `,_jsx(_components.a,{href:`/api/ciam/initiate-external-provider`,children:`Initiate External KYC Provider`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EKYC_FACE_PHOTO`})}),_jsx(_components.td,{children:`Customer must submit a live face photo`}),_jsxs(_components.td,{children:[`Call `,_jsx(_components.a,{href:`/api/ciam/initiate-external-provider`,children:`Initiate External KYC Provider`}),` and load the camera SDK.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_EKYC_FACE_VIDEO`})}),_jsx(_components.td,{children:`Customer must record a live face video`}),_jsxs(_components.td,{children:[`Call `,_jsx(_components.a,{href:`/api/ciam/initiate-external-provider`,children:`Initiate External KYC Provider`}),` and load the video SDK.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`VERIFY_ACCOUNT_VIA_IDENTIFICATION_DOCUMENT`})}),_jsx(_components.td,{children:`Customer must upload an identity document`}),_jsxs(_components.td,{children:[`Call `,_jsx(_components.a,{href:`/api/ciam/initiate-compliance-action`,children:`Initiate Compliance Action`}),`, then `,_jsx(_components.a,{href:`/api/ciam/attach-documents`,children:`Submit KYC Documents`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`OTHER`})}),_jsx(_components.td,{children:`Catch-all action type`}),_jsxs(_components.td,{children:[`Follow the `,_jsx(_components.code,{children:`customerInstruction`}),` field.`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`code-example`,children:`Code Example`}),`\n`,_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://{your-domain}.fincode.software/api/v6/services/compliance/awaiting-compliance-requirements'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'X-Auth-Token: YOUR_TOKEN'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'X-CUSTOMER-ID: 550e8400-e29b-41d4-a716-446655440000'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'platform: fincode'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'uuid: 200'`})]}),`\n`]})})})]})}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":"Awaiting Compliance Requirements","openapi":"GET /compliance/awaiting-compliance-requirements","description":"Returns the outstanding KYC requirements for a customer.","href":"/api/ciam/awaiting-compliance-requirements"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request Headers","slug":"request-headers","depth":2,"children":[]},{"title":"Query Parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Action Types","slug":"action-types","depth":2,"children":[]},{"title":"Code Example","slug":"code-example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Awaiting Compliance","description":"Returns the outstanding KYC requirements for a customer.","operationId":"awaitingCompliance","tags":["Compliance"],"parameters":["19889cdc-63a5-4f66-b47a-05c1f9f4875a","dc58fa05-ca55-43be-a424-1ccf13392d09","4791fd22-1c36-4f4b-b7f0-8f13fc1b36d4","cc7b0639-c21c-45cb-9c22-a9403427c121","0f532647-98bf-4cba-b187-fe39627654f3"],"responses":{"200":"273a04bf-0e3e-4b28-a1c9-a5cf88bff4bd"},"method":"get","type":"path","servers":["388ed13c-373d-48f0-851a-6d424543750e","22051531-c5d9-4892-b237-ff3e52a3c9a3","e8abf0c6-7333-4f42-95f9-0cf412119bb0"],"security":[],"path":"/compliance/awaiting-compliance-requirements","baseUrlOptions":["https://{your-domain}.fincode.software/api/v6/services","https://{your-domain}.fincode.software/api/v1/services","https://api.stag.songhaiexchange.io"],"title":"Awaiting Compliance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"19889cdc-63a5-4f66-b47a-05c1f9f4875a":{"in":"header","name":"platform","schema":{"type":"string","default":"fincode","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"dc58fa05-ca55-43be-a424-1ccf13392d09":{"in":"header","name":"uuid","schema":{"type":"string","default":"200","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"4791fd22-1c36-4f4b-b7f0-8f13fc1b36d4":{"in":"header","name":"X-Auth-Token","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"cc7b0639-c21c-45cb-9c22-a9403427c121":{"in":"header","name":"X-CUSTOMER-ID","schema":{"type":"string","format":"uuid","isRequired":false,"description":"The customer's userId UUID. Passed by agents or admin users to perform this lookup on behalf of a specific customer.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":false,"description":"The customer's userId UUID. Passed by agents or admin users to perform this lookup on behalf of a specific customer."},"0f532647-98bf-4cba-b187-fe39627654f3":{"in":"query","name":"userId","schema":{"type":"string","isRequired":false,"description":"Filter compliance requirements by this customer's userId.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Filter compliance requirements by this customer's userId."}},"responses":{"273a04bf-0e3e-4b28-a1c9-a5cf88bff4bd":{"description":"Compliance status retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESS","uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","example":"Awaiting compliance requirements for Jane Smith ( 447700000001 )","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"status":{"type":"string","example":"Success","uniqueKey":"data.status","typeLabel":"string"},"awaitingComplianceActions":{"type":"array","items":{"type":"object","properties":{"actionType":{"type":"string","enum":["VERIFY_ACCOUNT_VIA_EMAIL","VERIFY_ACCOUNT_VIA_PHONE_NUMBER","VERIFY_ACCOUNT_VIA_EKYC","VERIFY_ACCOUNT_VIA_EKYC_FACE_PHOTO","VERIFY_ACCOUNT_VIA_EKYC_FACE_VIDEO","VERIFY_ACCOUNT_VIA_IDENTIFICATION_DOCUMENT","CUSTOMER_RISK_ASSESSMENT","THRESHOLD_IDENTIFICATION","THRESHOLD_LIMIT","THRESHOLD_LIMIT_RECEIVING_AMOUNT","THRESHOLD_COUNT_TRANSACTION","LINKED_TRANSACTION","OTHER"],"example":"THRESHOLD_IDENTIFICATION","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"businessRuleNumber":{"type":"string","example":"90","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].businessRuleNumber","typeLabel":"string"},"restrictionLevel":{"type":"string","enum":["BLOCK","WARN","ALLOW"],"example":"BLOCK","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].restrictionLevel","typeLabel":"enum\u003cstring>"},"docIdType":{"oneOf":[{"type":"string","description":"Legacy field — document ID type from the first acceptable doc type.","example":"ADDRESS_PROOF","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].docIdType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy field — document ID type from the first acceptable doc type.","example":"ADDRESS_PROOF","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].docIdType.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].docIdType","typeLabel":"string | null"},"docTypeCommonName":{"oneOf":[{"type":"string","description":"Legacy field — common name of the first acceptable doc type.","example":"Proof of address","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].docTypeCommonName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy field — common name of the first acceptable doc type.","example":"Proof of address","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].docTypeCommonName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].docTypeCommonName","typeLabel":"string | null"},"customerInstruction":{"type":"string","example":"","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].customerInstruction","typeLabel":"string"},"associatedRuleId":{"type":"string","description":"Pass this as associatedRuleId when submitting documents via attach-documents.","example":"00000000-0000-0000-0000-000000000001","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].associatedRuleId","typeLabel":"string"},"dataCollectionFormType":{"type":"string","enum":["NONE_APPLICABLE","BASIC_FILE_UPLOAD","LOAD_CAMERA_AND_SEND_PHOTO","LOAD_CAMERA_AND_SEND_VIDEO","CUSTOMER_RISK_ASSESSMENT"],"example":"BASIC_FILE_UPLOAD","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].dataCollectionFormType","typeLabel":"enum\u003cstring>"},"acceptableDocType":{"oneOf":[{"type":"object","description":"Legacy field — single DocIdTypeDTO from the first acceptable doc type.","properties":{"docIdType":{"type":"string","example":"ADDRESS_PROOF","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocType.oneOf.0.docIdType","typeLabel":"string"},"docTypeCommonName":{"type":"string","example":"Proof of address","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocType.oneOf.0.docTypeCommonName","typeLabel":"string"}},"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocType.oneOf.0","typeLabel":"object"},{"type":"null","description":"Legacy field — single DocIdTypeDTO from the first acceptable doc type.","properties":{"docIdType":{"type":"string","example":"ADDRESS_PROOF"},"docTypeCommonName":{"type":"string","example":"Proof of address"}},"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocType.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocType","typeLabel":"object | null"},"craDynamicFieldIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].craDynamicFieldIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].craDynamicFieldIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].craDynamicFieldIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].craDynamicFieldIds","typeLabel":"string[] | null"},"ekycProviderId":{"oneOf":[{"type":"string","description":"Present when actionType is VERIFY_ACCOUNT_VIA_EKYC.","example":null,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].ekycProviderId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when actionType is VERIFY_ACCOUNT_VIA_EKYC.","example":null,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].ekycProviderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].ekycProviderId","typeLabel":"string | null"},"apiProvider":{"oneOf":[{"type":"string","description":"eKYC provider code.","example":"SHUFTI_PRO","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].apiProvider.oneOf.0","typeLabel":"string"},{"type":"null","description":"eKYC provider code.","example":"SHUFTI_PRO","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].apiProvider.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].apiProvider","typeLabel":"string | null"},"customerKycRecordId":{"type":"string","description":"Pass as the path parameter when calling initiate-compliance-action.","example":"00000000-0000-0000-0000-000000000002","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].customerKycRecordId","typeLabel":"string"},"craDynamicFormId":{"oneOf":[{"type":"string","example":null,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].craDynamicFormId.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].craDynamicFormId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].craDynamicFormId","typeLabel":"string | null"},"complianceScreeningType":{"type":"string","enum":["AML","CRA","KYC","EDD","NONE_APPLICABLE"],"example":"KYC","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].complianceScreeningType","typeLabel":"enum\u003cstring>"},"amountFrom":{"type":"number","example":0,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].amountFrom","typeLabel":"number"},"amountTo":{"type":"number","example":0,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].amountTo","typeLabel":"number"},"sendingAmount":{"type":"number","example":0,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].sendingAmount","typeLabel":"number"},"result":{"type":"string","enum":["PASS","WARNING","FAIL"],"example":"FAIL","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].result","typeLabel":"enum\u003cstring>"},"requestedDocumentUpload":{"type":"boolean","example":false,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].requestedDocumentUpload","typeLabel":"boolean"},"acceptableDocTypes":{"type":"array","items":{"type":"object","properties":{"docIdType":{"type":"string","example":"ADDRESS_PROOF","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocTypes.items.[INDEX].docIdType","typeLabel":"string"},"docTypeCommonName":{"type":"string","example":"Proof of address","uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocTypes.items.[INDEX].docTypeCommonName","typeLabel":"string"}},"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocTypes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].acceptableDocTypes","typeLabel":"object[]"},"minimumNumberOfAcceptableDocTypes":{"type":"integer","example":0,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].minimumNumberOfAcceptableDocTypes","typeLabel":"integer"},"complianceOn":{"oneOf":[{"type":"string","enum":["CUSTOMER","RECEIVER"],"example":null,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].complianceOn.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CUSTOMER","RECEIVER"],"example":null,"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].complianceOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.awaitingComplianceActions.items.[INDEX].complianceOn","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"data.awaitingComplianceActions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.awaitingComplianceActions","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"SUCCESS","message":"Awaiting compliance requirements for Jane Smith ( 447700000001 )","data":{"status":"Success","awaitingComplianceActions":[{"actionType":"THRESHOLD_IDENTIFICATION","businessRuleNumber":"90","restrictionLevel":"BLOCK","docIdType":"ADDRESS_PROOF","docTypeCommonName":"Proof of address","customerInstruction":"","associatedRuleId":"00000000-0000-0000-0000-000000000001","dataCollectionFormType":"BASIC_FILE_UPLOAD","acceptableDocType":{"docIdType":"ADDRESS_PROOF","docTypeCommonName":"Proof of address"},"craDynamicFieldIds":["\u003cstring>"],"ekycProviderId":null,"apiProvider":"SHUFTI_PRO","customerKycRecordId":"00000000-0000-0000-0000-000000000002","craDynamicFormId":null,"complianceScreeningType":"KYC","amountFrom":0,"amountTo":0,"sendingAmount":0,"result":"FAIL","requestedDocumentUpload":false,"acceptableDocTypes":[{"docIdType":"ADDRESS_PROOF","docTypeCommonName":"Proof of address"}],"minimumNumberOfAcceptableDocTypes":0,"complianceOn":null}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"388ed13c-373d-48f0-851a-6d424543750e":{"url":"https://{your-domain}.fincode.software/api/v6/services","description":"API v6","variables":{"your-domain":{"default":"remitjunction","description":"Enter your subdomain"}}},"22051531-c5d9-4892-b237-ff3e52a3c9a3":{"url":"https://{your-domain}.fincode.software/api/v1/services","description":"API v1","variables":{"your-domain":{"default":"finlend","description":"Enter your subdomain"}}},"e8abf0c6-7333-4f42-95f9-0cf412119bb0":{"url":"https://api.stag.songhaiexchange.io","description":"Songhai Exchange API"}}},"originalFileLocation":"openapi.json"},"subdomain":"fincode","siteName":"FinCode Platform","title":"Awaiting Compliance Requirements - FinCode Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T10:12:14.310Z","originalFileLocation":"api/ciam/awaiting-compliance-requirements.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=\"light\"}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=\"Returns the outstanding KYC requirements for a customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"FinCode Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Awaiting Compliance Requirements - FinCode Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the outstanding KYC requirements for a customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FinCode Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fincode.mintlify.site/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Awaiting+Compliance+Requirements\u0026amp;description=Returns+the+outstanding+KYC+requirements+for+a+customer.\u0026amp;theme=5cb295c43f2caf87cf931732\u0026amp;signature=0fb185431d1ca8d07e3e7cdc2eeb84f82e117b699505ac26a80098ff04f191e9\">\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=\"Awaiting Compliance Requirements - FinCode Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the outstanding KYC requirements for a customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fincode.mintlify.site/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Awaiting+Compliance+Requirements\u0026amp;description=Returns+the+outstanding+KYC+requirements+for+a+customer.\u0026amp;theme=5cb295c43f2caf87cf931732\u0026amp;signature=0fb185431d1ca8d07e3e7cdc2eeb84f82e117b699505ac26a80098ff04f191e9\">\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/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FinCode Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#734CDC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/ciam/awaiting-compliance-requirements.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fincode.technology/#organization\",\"name\":\"FinCode Platform\",\"url\":\"https://docs.fincode.technology\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fincode.technology#website\",\"name\":\"FinCode Platform\",\"url\":\"https://docs.fincode.technology\",\"publisher\":{\"@id\":\"https://docs.fincode.technology/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements#webpage\",\"url\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements\",\"name\":\"Awaiting Compliance Requirements\",\"description\":\"Returns the outstanding KYC requirements for a customer.\",\"dateModified\":\"2026-09-29T10:12:14.310Z\",\"isPartOf\":{\"@id\":\"https://docs.fincode.technology#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://docs.fincode.technology/api/ciam/profile\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Awaiting Compliance Requirements\",\"item\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements#apireference\",\"headline\":\"Awaiting Compliance Requirements\",\"name\":\"Awaiting Compliance Requirements\",\"description\":\"Returns the outstanding KYC requirements for a customer.\",\"url\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements#webpage\"},\"dateModified\":\"2026-09-29T10:12:14.310Z\",\"publisher\":{\"@id\":\"https://docs.fincode.technology/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fincode.technology#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FinCode Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FinCode Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/ciam/awaiting-compliance-requirements.md","siteName":"FinCode Platform","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Remittance","pages":[{"title":"Remittance","href":"/remittance/overview"}]},{"tab":"Lending","pages":[{"title":"Lending","href":"/lending/overview"}]},{"tab":"Savings \u0026 Investment","pages":[{"title":"Savings \u0026 Investment","href":"/investment/overview"}]},{"tab":"Customer Identity \u0026 Access Management","groups":[{"group":"Getting Started","pages":[{"title":"Overview","icon":"atom","href":"/ciam/overview"}]},{"group":"API Endpoints","pages":[{"title":"Customer Profile","openapi":"GET /usermanagement/profile","href":"/api/ciam/profile"},{"title":"Get Customer By ID","openapi":"GET /admin/customer-management/profile/{id}","href":"/api/ciam/customer-by-id"},{"title":"Deactivate User Account","openapi":"GET /usermanagement/deactivate-user-account/{id}","href":"/api/ciam/deactivate-user"},{"title":"Activate User Account","openapi":"GET /usermanagement/activate-user-account/{id}","href":"/api/ciam/activate-user"},{"title":"Find Customer By Name or Phone","openapi":"GET /usermanagement/find-customer-by-name-or-phone-no/{search-criteria}","href":"/api/ciam/find-customer-by-name-or-phone-no"},{"title":"Generate and send otp toemail","href":"/api/ciam/generate-and-send-otp-toemail"},{"title":"List Employees","openapi":"GET /admin/employee-management/list-employees","href":"/api/ciam/list-employees"},{"title":"Start/Continue Verification","openapi":"GET /admin/compliance/continue-enrolment","href":"/api/ciam/continue-enrolment"},{"title":"Get Dynamic Fields","openapi":"GET /dynamicfields/dynamic-fields-group/{processGroupCode}","href":"/api/ciam/dynamic-fields"},{"title":"Get Pay Centre By ID","openapi":"GET /admin/pay-centre-management/pay-centre-by/{id}","href":"/api/ciam/pay-centre-by-id"},{"title":"List Connectors","openapi":"GET /admin/connector-management/list-connectors","href":"/api/ciam/list-connectors"},{"title":"Reset Password","openapi":"GET /securitymanagement/reset-password/{email}","href":"/api/ciam/reset-password"},{"title":"KYC Detail By ID","openapi":"GET /admin/compliance/kyc-detail/{id}","href":"/api/ciam/kyc-detail-by-id"},{"title":"Dynamic Fields Group","openapi":"GET /dynamicfields/dynamic-fields-group/{groupName}","href":"/api/ciam/dynamic-fields-group"},{"title":"View Password Policy","openapi":"GET /admin/security/view-password-policy","href":"/api/ciam/view-password-policy"},{"title":"Fetch Organisation Preference","openapi":"GET /admin/organisation-preference-management/fetch-organisaction-preference","href":"/api/ciam/fetch-organisaction-preference"},{"title":"List Customers","openapi":"GET /admin/customer-management/list-customers","href":"/api/ciam/list-customers"},{"title":"List Attached Dynamic Forms","openapi":"GET /admin/compliance/list-attached-form","href":"/api/ciam/cra-forms"},{"title":"Verify Customer","openapi":"GET /admin/customer-management/verify-customer/{id}","href":"/api/ciam/verify-customer"},{"title":"KYC Requirements by Country","openapi":"GET /compliance/kyc-requirements-by-isocountry/{countryIso}/{triggerPoint}","description":"Retrieves KYC requirements for a specific country.","href":"/api/ciam/kyc-requirements-by-isocountry"},{"title":"Awaiting Compliance Requirements","openapi":"GET /compliance/awaiting-compliance-requirements","href":"/api/ciam/awaiting-compliance-requirements"},{"title":"Pre-Transaction Compliance Checklist","openapi":"PUT /compliance/customer-compliance-checklist","description":"Returns the compliance checklist a customer must satisfy before a transaction can be booked.","href":"/api/ciam/compliance-checklist"},{"title":"Organisation Compliance Policy","openapi":"GET /compliance/list-organisation-compliance-policy","href":"/api/ciam/list-organisation-compliance-policy"},{"title":"List Pay Centers by Type","openapi":"GET /branches/list-paycenters-by-type/{type}","href":"/api/ciam/list-paycenters-by-type"},{"title":"List AML Rules","openapi":"GET /admin/compliance/list-aml-rules","href":"/api/ciam/list-aml-rules"},{"title":"Change Password","openapi":"PUT /securitymanagement/change-password","href":"/api/ciam/change-password"},{"title":"Edit Customer Profile","openapi":"PUT /usermanagement/profile-edit","href":"/api/ciam/edit-profile"},{"title":"Update Connector Instance","openapi":"PUT /admin/connector-management/update-connector-instance","href":"/api/ciam/update-connector-instance"},{"title":"Delete Customer Bank Details","openapi":"DELETE /bankmanagement/delete-customer-bank-details/{account-owner-id}/{bank-detail-id}","href":"/api/ciam/delete-customer-bank-details"},{"title":"Awaiting Payments","openapi":"PUT /admin/payment-management/awaiting-payments","href":"/api/ciam/awaiting-payments"},{"title":"Upload Profile Picture","openapi":"PUT /documentmanagement/upload-profile-picture","href":"/api/ciam/upload-profile-picture"},{"title":"Edit Employee","openapi":"PUT /admin/employee-management/edit-employee/{id}","href":"/api/ciam/edit-employee"},{"title":"Update Organisation Preference","openapi":"PUT /admin/organisation-preference-management/update-organisaction-preference","href":"/api/ciam/update-organisaction-preference"},{"title":"Deactivate AML Rule","openapi":"PUT /admin/compliance/deactivate-aml-rule/{id}","href":"/api/ciam/deactivate-aml-rule"},{"title":"Activate AML Rule","openapi":"PUT /admin/compliance/activate-aml-rule/{id}","href":"/api/ciam/activate-aml-rule"},{"title":"Update AML Rules","openapi":"PUT /admin/compliance/update-aml-rules","href":"/api/ciam/update-aml-rules"},{"title":"Edit KYC Rule","openapi":"PUT /admin/compliance/edit-kyc-rule","href":"/api/ciam/edit-kyc-rule"},{"title":"Create Transaction PIN","openapi":"POST /usermanagement/create-transaction-pin","href":"/api/ciam/create-transaction-pin"},{"title":"Create Customer","openapi":"POST /usermanagement/register-customer","href":"/api/ciam/create-customer"},{"title":"Verify Login OTP","openapi":"POST /securitymanagement/verify-login-otp","href":"/api/ciam/verify-login-otp"},{"title":"Submit CRA Form","openapi":"POST /admin/compliance/submit-cra","href":"/api/ciam/submit-cra"},{"title":"Create User PIN","openapi":"POST /securitymanagement/create-user-pin","href":"/api/ciam/create-user-pin"},{"title":"List Pay Points","openapi":"POST /branches/listpaypoints","href":"/api/ciam/listpaypoints"},{"title":"List Payout Points","openapi":"POST /branches/listpayoutpoints","href":"/api/ciam/listpayoutpoints"},{"title":"Add Default Charge","openapi":"POST /admin/fee-management/add-default-charge","href":"/api/ciam/add-default-charge"},{"title":"Create Connector Instance","openapi":"POST /admin/connector-management/create-connector-instance","href":"/api/ciam/create-connector-instance"},{"title":"Product Payment Details","openapi":"POST /admin/account-product/payment-details","href":"/api/ciam/product-payment-details"},{"title":"List Payment Collectors by Address","openapi":"POST /branches/listpaymentcollectorsbyaddress","href":"/api/ciam/listpaymentcollectorsbyaddress"},{"title":"List Allocated Payout Points","openapi":"POST /branches/listallocatedpayoutpoints","href":"/api/ciam/listallocatedpayoutpoints"},{"title":"Payout Center Branches","openapi":"POST /branches/payoutCenter","href":"/api/ciam/payoutCenter-branches"},{"title":"Documents Required For Transaction","openapi":"POST /complaince/documents-required-for-transaction","href":"/api/ciam/documents-required-for-transaction"},{"title":"Submit KYC Documents","openapi":"POST /documentmanagement/attach-documents","href":"/api/ciam/attach-documents"},{"title":"Initiate Compliance Action","openapi":"GET /compliance/initiate-awaiting-compliance-action/{customer-kyc-record-id}","href":"/api/ciam/initiate-compliance-action"},{"title":"Initiate External KYC Provider","openapi":"POST /compliance/external-provider/initiate","href":"/api/ciam/initiate-external-provider"},{"title":"External Screening Webhook","openapi":"POST /compliance/external-screening/webhooks/{provider-code}","href":"/api/ciam/external-screening-webhook"},{"title":"Verify Contact","openapi":"POST /compliance/external-provider/verify-contact","href":"/api/ciam/verify-contact"},{"title":"OTP Verification","openapi":"GET /securitymanagement/otp-verification/{email}/{verification-code}","href":"/api/ciam/otp-verification"},{"title":"Add KYC Rule","openapi":"POST /admin/compliance/add-kyc-rule","href":"/api/ciam/add-kyc-rule"},{"title":"Delete API Connector Instance","openapi":"DELETE /admin/connector-management/delete-api-connector-instance/{id}","href":"/api/ciam/delete-api-connector-instance"}]}]},{"tab":"Payment Switch","pages":[{"title":"Payment Switch","href":"/songhai-exchange/overview"}]},{"tab":"Ledger Engine","pages":[{"title":"Ledger Engine","href":"/ledger/overview"}]},{"tab":"Deposit Engine","pages":[{"title":"Deposit Engine","href":"/deposit-engine/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"API Reference","icon":"code","href":"/api/authentication"}]},{"group":"Authentication","pages":[{"title":"Login","openapi":"PUT /securitymanagement/login","href":"/api/auth/login"},{"title":"Logout","openapi":"PUT /securitymanagement/logout","href":"/api/auth/logout"},{"title":"Refresh Token","openapi":"PUT /securitymanagement/refresh-token","href":"/api/auth/refresh-token"}]},{"group":"Security \u0026 Utilities","pages":[{"title":"List Countries","openapi":"GET /utilitiesmanagement/list-all-countries","href":"/api/security/list-countries"},{"title":"Active Countries","openapi":"GET /utilitiesmanagement/active-countries","href":"/api/security/active-countries"},{"title":"Password Policy","openapi":"GET /admin/security/view-password-policy","href":"/api/security/password-policy"},{"title":"Fetch Preference","openapi":"GET /admin/organisation-preference-management/fetch-organisaction-preference","href":"/api/security/fetch-preference"}]},{"group":"Remittance","pages":[{"title":"Wallet Account List","openapi":"GET /walletmanagement/walletaccountlist","href":"/api/transactions/wallet-account"},{"title":"Find All Beneficiary","openapi":"GET /usermanagement/find-all-beneficiery","href":"/api/transactions/beneficiary-list"},{"title":"Transaction Types","openapi":"GET /transactionmanagement/transaction-types","href":"/api/transactions/transaction-types"},{"title":"Beneficiary Details","openapi":"GET /usermanagement/view-beneficiery-details/{beneficiaryId}","href":"/api/transactions/beneficiary-details"},{"title":"Delivery Currencies","openapi":"GET /quote/supported-delivery-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}/{sendingCurrencyCode}","href":"/api/transactions/delivery-currencies"},{"title":"Destination Countries","openapi":"GET /quote/destination-country-by-delivery-method/{sendingCountryCode}/{deliveryMethod}","href":"/api/transactions/destination-countries"},{"title":"Supported Currencies","openapi":"GET /quote/supported-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}","href":"/api/transactions/supported-currencies"},{"title":"Validate Recipient Account","openapi":"GET /usermanagement/validate-bank-account","href":"/api/transactions/validate-account"},{"title":"List Supported Banks","openapi":"GET /bankmanagement/list-supported-banks-iso3/{country}","href":"/api/transactions/list-supported-banks"},{"title":"Required Bank Fields","openapi":"GET /bankmanagement/required-bank-fields/{country}","href":"/api/transactions/required-bank-fields"},{"title":"List Mobile Operators","openapi":"GET /admin/bank/config/find-all-mobile-operator/{country}","href":"/api/transactions/list-mobile-operators"},{"title":"Add Bank Details","openapi":"POST /bankmanagement/add-bank-details-key-value-pairs","href":"/api/transactions/add-bank-details"},{"title":"Get Transaction Quote","openapi":"POST /quote/callQuote","href":"/api/transactions/call-quote"},{"title":"Payment Methods","api":"POST /paymentmanagement/supported-payment-methods","href":"/api/transactions/payment-methods"},{"title":"Create Beneficiary","openapi":"POST /usermanagement/new-beneficiary","href":"/api/transactions/create-beneficiary"},{"title":"Customer Transaction History","openapi":"POST /transactionmanagement/history-data","href":"/api/transactions/history-data"},{"title":"Check Transaction Status","openapi":"GET /transactionmanagement/checktransactionstatus/{transaction_identification_number}","href":"/api/transactions/check-transaction-status"},{"title":"Fetch Transaction Details","openapi":"GET /transactionmanagement/fetch-payable-type/{pcn}/{payable_type}","href":"/api/transactions/fetch-transaction-details"},{"title":"Create Transaction","openapi":"POST /transactionmanagement/create-transaction","href":"/api/transactions/create-transaction"},{"title":"Create Transaction (Direct)","openapi":"POST /transactionmanagement/create-transaction","href":"/api/transactions/create-transaction-direct"}]},{"group":"Lending","pages":[{"title":"Get Application","openapi":"GET /admin/loan-application/{loan-application-id}","href":"/api/lending/get-application"},{"title":"List Loan Products","openapi":"GET /user/list-products","href":"/api/lending/list-products"},{"title":"Eligibility Questions","openapi":"GET /user/loan-eligibility-questions/{productId}","href":"/api/lending/loan-eligibility-questions"},{"title":"Loan History","openapi":"GET /user/get-loan-history/{customerId}","href":"/api/lending/get-loan-history"},{"title":"Customers Total Loan","openapi":"GET /user/get-total/{customerId}","href":"/api/lending/get-total-loan"},{"title":"Get Loan Offer","openapi":"GET /user/get-loan-offer","href":"/api/lending/get-loan-offer"},{"title":"Available Banks","openapi":"GET /user/get-available-banks/","href":"/api/lending/get-available-banks"},{"title":"Verify Bank Account","openapi":"GET /user/verify-bank-account/{bankCode}/{accountNumber}","href":"/api/lending/verify-bank-account"},{"title":"List Bank Accounts","openapi":"GET /user/list-customer-bank-accounts/{customerId}","href":"/api/lending/list-customer-bank-accounts"},{"title":"Transfer History","openapi":"GET /user/transfer-history/{customerId}","href":"/api/lending/transfer-history"},{"title":"Manage Loans","openapi":"GET /user/manage-loans/{customerId}","href":"/api/lending/manage-loans"},{"title":"List Repayments","openapi":"GET /admin/repayments/list","href":"/api/lending/list-repayments"},{"title":"Transfer Status","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference}","href":"/api/lending/transfer-status"},{"title":"Get Loan Terms","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/get-loan-terms/{organisationId}","href":"/api/lending/get-loan-terms"},{"title":"Pending Repayments","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/pending-repayments/{user-id}","href":"/api/lending/pending-repayments"},{"title":"Repaid Transactions","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/repaid-transactions/{user-id}","href":"/api/lending/repaid-transactions"},{"title":"Repayment Instructions","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/repayment-instructions/{loan-application-id}","href":"/api/lending/repayment-instructions"},{"title":"Loan Details with Payment History","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id}","href":"/api/lending/loan-details-with-payment-history"},{"title":"View Bank Account","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/view-bank-account/{account-id}","href":"/api/lending/view-bank-account"},{"title":"Loan Application Details","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/loan-application-details/{loan-application-id}","href":"/api/lending/loan-application-details"},{"title":"List Customer Repayments","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/list-customer-repayments/{customer-id}","href":"/api/lending/list-customer-repayments"},{"title":"Update Loan Offer","api":"PUT https://{your-domain}.fincode.software/api/v1/services/user/update-application/{loan-application-id}","href":"/api/lending/update-application"},{"title":"Accept Loan Offer","openapi":"PUT /user/accept-loan-offer/{loanApplicationId}/accept","href":"/api/lending/accept-loan-offer"},{"title":"Reject Loan Offer","openapi":"PUT /user/accept-loan-offer/{loanApplicationId}/reject","href":"/api/lending/reject-loan-offer"},{"title":"Accept Loan Terms","openapi":"PUT /user/accept-terms-and-conditions/{loanApplicationId}","href":"/api/lending/accept-loan-terms"},{"title":"Transfer Funds to Bank","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/transfer-funds-to-bank","href":"/api/lending/transfer-funds"},{"title":"Payoff Loan","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/payoff-loan","href":"/api/lending/payoff-loan"},{"title":"Repay Loan","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/repay-loan/{user-id}","href":"/api/lending/repay-loan"},{"title":"Calculate APR","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/calculate-apr","href":"/api/lending/calculate-apr"},{"title":"Add Bank Account","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/create-bank-account","href":"/api/lending/add-bank-account"},{"title":"Request Loan","openapi":"POST /user/request-loan","href":"/api/lending/loan-request"}]},{"group":"Ledger Engine","pages":[{"title":"Account Balance","openapi":"GET /ledger/account-balance/{account_id}","href":"/api/ledger/account-balance"},{"title":"Ledger History","openapi":"GET /ledger/account-ledger-history/{account_id}/{page}/{size}","href":"/api/ledger/ledger-history"},{"title":"Ledger History by ID","openapi":"GET /ledger/account-ledger-history-interaction-id","href":"/api/ledger/ledger-history-interaction-id"},{"title":"Ledger History by Idempotency Key","openapi":"GET /ledger/account-ledger-history-idempotencykey","href":"/api/ledger/ledger-history-idempotency-key"},{"title":"List Accounts","openapi":"GET /account-maintenance/list-accounts/{account-owner-id}","href":"/api/ledger/list-accounts"},{"title":"Change Account Permission","openapi":"GET /account-maintenance/change-account-permission/{id}/{permission}","href":"/api/ledger/change-account-permission"},{"title":"Post to Account","openapi":"POST /gateway/post-account","href":"/api/ledger/post-account"}]},{"group":"Savings \u0026 Investment","pages":[{"title":"Get Total Investments","openapi":"GET /get-total/{user-id}","href":"/api/investment/get-total-investments"},{"title":"List Customer Portfolios","openapi":"GET /portfolios/{customer-id}","href":"/api/investment/list-portfolios"},{"title":"Get Investment Quote","openapi":"GET /quote/get-quote/{product-id}/{number-of-units-to-purchase}","href":"/api/investment/get-quote"},{"title":"Fund Wallet","openapi":"PUT /wallet/fund-wallet/{wallet-id}/{amount}","href":"/api/investment/fund-wallet"},{"title":"Create Investment Application","openapi":"POST /apply","href":"/api/investment/create-investment-application"}]},{"group":"Deposit Engine","pages":[{"title":"List Awaiting Payments","openapi":"GET /paymentmanagement/awaiting-payments","href":"/api/deposit-engine/awaiting-payments"},{"title":"Bank Pay Later (Wallet)","openapi":"PUT /paymentmanagement/bank-iwillpaylater-wallet/{pcn}/{payableType_String}","href":"/api/deposit-engine/bank-iwillpaylater"},{"title":"Awaiting Payment Actions","openapi":"POST /paymentmanagement/awaiting-payment-actions","href":"/api/deposit-engine/awaiting-payment-actions"},{"title":"Payment Methods Charges","openapi":"POST /paymentmanagement/payment-methods-charges","href":"/api/deposit-engine/payment-methods-charges"},{"title":"Notify Bank Transfer Payment","openapi":"POST /paymentmanagement/notify-bank-transfer-payment","href":"/api/deposit-engine/notify-bank-transfer-payment"},{"title":"Supported Payment Methods","openapi":"POST /paymentmanagement/supported-payment-methods","href":"/api/deposit-engine/supported-payment-methods"},{"title":"Make Payment from Wallet","openapi":"POST /paymentmanagement/makepaymentfromwalletaccount","href":"/api/deposit-engine/make-payment-from-wallet"},{"title":"Fund Customer Wallet by Payment Token","openapi":"POST /paymentmanagement/processpaymentwithpaymenttoken","href":"/api/deposit-engine/process-payment-with-token"},{"title":"Process Card Payment","openapi":"POST /paymentmanagement/process-card-payment","href":"/api/deposit-engine/process-card-payment"}]},{"group":"Customer Identity \u0026 Access Management","pages":[{"title":"Customer Profile","openapi":"GET /usermanagement/profile","href":"/api/ciam/profile"},{"title":"Get Customer By ID","openapi":"GET /admin/customer-management/profile/{id}","href":"/api/ciam/customer-by-id"},{"title":"Deactivate User Account","openapi":"GET /usermanagement/deactivate-user-account/{id}","href":"/api/ciam/deactivate-user"},{"title":"Activate User Account","openapi":"GET /usermanagement/activate-user-account/{id}","href":"/api/ciam/activate-user"},{"title":"Find Customer By Name or Phone","openapi":"GET /usermanagement/find-customer-by-name-or-phone-no/{search-criteria}","href":"/api/ciam/find-customer-by-name-or-phone-no"},{"title":"Generate and send otp toemail","href":"/api/ciam/generate-and-send-otp-toemail"},{"title":"List Employees","openapi":"GET /admin/employee-management/list-employees","href":"/api/ciam/list-employees"},{"title":"Start/Continue Verification","openapi":"GET /admin/compliance/continue-enrolment","href":"/api/ciam/continue-enrolment"},{"title":"Get Dynamic Fields","openapi":"GET /dynamicfields/dynamic-fields-group/{processGroupCode}","href":"/api/ciam/dynamic-fields"},{"title":"Get Pay Centre By ID","openapi":"GET /admin/pay-centre-management/pay-centre-by/{id}","href":"/api/ciam/pay-centre-by-id"},{"title":"List Connectors","openapi":"GET /admin/connector-management/list-connectors","href":"/api/ciam/list-connectors"},{"title":"Reset Password","openapi":"GET /securitymanagement/reset-password/{email}","href":"/api/ciam/reset-password"},{"title":"KYC Detail By ID","openapi":"GET /admin/compliance/kyc-detail/{id}","href":"/api/ciam/kyc-detail-by-id"},{"title":"Dynamic Fields Group","openapi":"GET /dynamicfields/dynamic-fields-group/{groupName}","href":"/api/ciam/dynamic-fields-group"},{"title":"View Password Policy","openapi":"GET /admin/security/view-password-policy","href":"/api/ciam/view-password-policy"},{"title":"Fetch Organisation Preference","openapi":"GET /admin/organisation-preference-management/fetch-organisaction-preference","href":"/api/ciam/fetch-organisaction-preference"},{"title":"List Customers","openapi":"GET /admin/customer-management/list-customers","href":"/api/ciam/list-customers"},{"title":"Verify Customer","openapi":"GET /admin/customer-management/verify-customer/{id}","href":"/api/ciam/verify-customer"},{"title":"KYC Requirements by Country","openapi":"GET /compliance/kyc-requirements-by-isocountry/{countryIso}/{triggerPoint}","description":"Retrieves KYC requirements for a specific country.","href":"/api/ciam/kyc-requirements-by-isocountry"},{"title":"Awaiting Compliance Requirements","openapi":"GET /compliance/awaiting-compliance-requirements","href":"/api/ciam/awaiting-compliance-requirements"},{"title":"Pre-Transaction Compliance Checklist","openapi":"PUT /compliance/customer-compliance-checklist","description":"Returns the compliance checklist a customer must satisfy before a transaction can be booked.","href":"/api/ciam/compliance-checklist"},{"title":"Organisation Compliance Policy","openapi":"GET /compliance/list-organisation-compliance-policy","href":"/api/ciam/list-organisation-compliance-policy"},{"title":"List Pay Centers by Type","openapi":"GET /branches/list-paycenters-by-type/{type}","href":"/api/ciam/list-paycenters-by-type"},{"title":"List Attached Dynamic Forms","openapi":"GET /admin/compliance/list-attached-form","href":"/api/ciam/cra-forms"},{"title":"List AML Rules","openapi":"GET /admin/compliance/list-aml-rules","href":"/api/ciam/list-aml-rules"},{"title":"Change Password","openapi":"PUT /securitymanagement/change-password","href":"/api/ciam/change-password"},{"title":"Edit Customer Profile","openapi":"PUT /usermanagement/profile-edit","href":"/api/ciam/edit-profile"},{"title":"Update Connector Instance","openapi":"PUT /admin/connector-management/update-connector-instance","href":"/api/ciam/update-connector-instance"},{"title":"Delete Customer Bank Details","openapi":"DELETE /bankmanagement/delete-customer-bank-details/{account-owner-id}/{bank-detail-id}","href":"/api/ciam/delete-customer-bank-details"},{"title":"Awaiting Payments","openapi":"PUT /admin/payment-management/awaiting-payments","href":"/api/ciam/awaiting-payments"},{"title":"Upload Profile Picture","openapi":"PUT /documentmanagement/upload-profile-picture","href":"/api/ciam/upload-profile-picture"},{"title":"Edit Employee","openapi":"PUT /admin/employee-management/edit-employee/{id}","href":"/api/ciam/edit-employee"},{"title":"Update Organisation Preference","openapi":"PUT /admin/organisation-preference-management/update-organisaction-preference","href":"/api/ciam/update-organisaction-preference"},{"title":"Deactivate AML Rule","openapi":"PUT /admin/compliance/deactivate-aml-rule/{id}","href":"/api/ciam/deactivate-aml-rule"},{"title":"Activate AML Rule","openapi":"PUT /admin/compliance/activate-aml-rule/{id}","href":"/api/ciam/activate-aml-rule"},{"title":"Update AML Rules","openapi":"PUT /admin/compliance/update-aml-rules","href":"/api/ciam/update-aml-rules"},{"title":"Edit KYC Rule","openapi":"PUT /admin/compliance/edit-kyc-rule","href":"/api/ciam/edit-kyc-rule"},{"title":"Create Transaction PIN","openapi":"POST /usermanagement/create-transaction-pin","href":"/api/ciam/create-transaction-pin"},{"title":"Create Customer","openapi":"POST /usermanagement/register-customer","href":"/api/ciam/create-customer"},{"title":"Verify Login OTP","openapi":"POST /securitymanagement/verify-login-otp","href":"/api/ciam/verify-login-otp"},{"title":"Submit CRA Form","openapi":"POST /admin/compliance/submit-cra","href":"/api/ciam/submit-cra"},{"title":"Create User PIN","openapi":"POST /securitymanagement/create-user-pin","href":"/api/ciam/create-user-pin"},{"title":"List Pay Points","openapi":"POST /branches/listpaypoints","href":"/api/ciam/listpaypoints"},{"title":"List Payout Points","openapi":"POST /branches/listpayoutpoints","href":"/api/ciam/listpayoutpoints"},{"title":"Add Default Charge","openapi":"POST /admin/fee-management/add-default-charge","href":"/api/ciam/add-default-charge"},{"title":"Create Connector Instance","openapi":"POST /admin/connector-management/create-connector-instance","href":"/api/ciam/create-connector-instance"},{"title":"Product Payment Details","openapi":"POST /admin/account-product/payment-details","href":"/api/ciam/product-payment-details"},{"title":"List Payment Collectors by Address","openapi":"POST /branches/listpaymentcollectorsbyaddress","href":"/api/ciam/listpaymentcollectorsbyaddress"},{"title":"List Allocated Payout Points","openapi":"POST /branches/listallocatedpayoutpoints","href":"/api/ciam/listallocatedpayoutpoints"},{"title":"Payout Center Branches","openapi":"POST /branches/payoutCenter","href":"/api/ciam/payoutCenter-branches"},{"title":"Documents Required For Transaction","openapi":"POST /complaince/documents-required-for-transaction","href":"/api/ciam/documents-required-for-transaction"},{"title":"Submit KYC Documents","openapi":"POST /documentmanagement/attach-documents","href":"/api/ciam/attach-documents"},{"title":"Initiate Compliance Action","openapi":"GET /compliance/initiate-awaiting-compliance-action/{customer-kyc-record-id}","href":"/api/ciam/initiate-compliance-action"},{"title":"Initiate External KYC Provider","openapi":"POST /compliance/external-provider/initiate","href":"/api/ciam/initiate-external-provider"},{"title":"External Screening Webhook","openapi":"POST /compliance/external-screening/webhooks/{provider-code}","href":"/api/ciam/external-screening-webhook"},{"title":"Verify Contact","openapi":"POST /compliance/external-provider/verify-contact","href":"/api/ciam/verify-contact"},{"title":"OTP Verification","openapi":"GET /securitymanagement/otp-verification/{email}/{verification-code}","href":"/api/ciam/otp-verification"},{"title":"Add KYC Rule","openapi":"POST /admin/compliance/add-kyc-rule","href":"/api/ciam/add-kyc-rule"},{"title":"Delete API Connector Instance","openapi":"DELETE /admin/connector-management/delete-api-connector-instance/{id}","href":"/api/ciam/delete-api-connector-instance"}]},{"group":"Songhai Exchange (Payment Switch)","pages":[{"title":"Change Password","openapi":"PUT /v1/services/usermanagement/change-password/{id}","href":"/api/songhai-exchange/change-password"},{"title":"Generate Token","openapi":"POST /oauth/token","href":"/api/songhai-exchange/generate-token"},{"title":"Exchange Rate","openapi":"POST /gateway/quote","href":"/api/songhai-exchange/exchange-rate"},{"title":"Create Transaction","openapi":"POST /gateway/transaction/banktransfers","href":"/api/songhai-exchange/create-transaction"},{"title":"Check Transaction Status","openapi":"POST /gateway/transaction/checkstatus","href":"/api/songhai-exchange/transaction-status"},{"title":"Client End-of-Day Report","openapi":"POST /gateway/list-end-Of-day-position-report","href":"/api/songhai-exchange/end-of-day-report"},{"title":"Generating Wallet Account Statement","openapi":"POST /v1/services/walletmanagement/walletledgerbyclient/{startDate}/{endDate}/{currency}/","href":"/api/songhai-exchange/wallet-account-statement"},{"title":"Bank Account Validation","openapi":"POST /gateway/v2/account-number-validation","href":"/api/songhai-exchange/bank-account-validation"},{"title":"Mobile Money Creation","openapi":"POST /gateway/v3/transaction/mobilemoney","href":"/api/songhai-exchange/mobile-money-creation"},{"title":"Mobile Money Validation","openapi":"POST /gateway/account-number-validation","href":"/api/songhai-exchange/mobile-money-validation"},{"title":"Domiciliary Account (Account Number)","openapi":"POST /gateway/create-domiciliary-bank-account","href":"/api/songhai-exchange/domiciliary-account-with-account-number"},{"title":"Domiciliary Account (BVN)","openapi":"POST /gateway/create-domiciliary-bank-account-with-bvn","href":"/api/songhai-exchange/domiciliary-account-with-bvn"}]},{"group":"Webhooks \u0026 Events","pages":[{"title":"Webhooks","href":"/api/webhooks"},{"title":"Webhook Security","href":"/api/webhook-security"}]},{"group":"Testing \u0026 Tools","pages":[{"title":"Postman collection","href":"/api/postman-collection"}]}]}]},"basePath":"","title":"Awaiting Compliance Requirements - FinCode Platform","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}