Results that have been evaluated for this entity, the lack of Result object value for a Result Type indicates that a check has been done for a transaction resulting in that result being produced
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://www.mintlify.com/docs.json","name":"frankieone","colors":{"primary":"#1A6CFF","light":"#1A6CFF","dark":"#1A6CFF"},"logo":{"light":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/light.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=21923909c20fa1b38b317371ccac6e33","dark":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/dark.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=196c598869b49c924efc8e44399fda09","href":"https://docs.frankieone.com"},"favicon":"https://mintcdn.com/frankieone-f5583b1b/cNmgsKD2V0ccWp6T/favicon.png?fit=max\u0026auto=format\u0026n=cNmgsKD2V0ccWp6T\u0026q=85\u0026s=82de5d057bc772d870f18df413b453f9","appearance":{"default":"system","strict":true},"background":{"color":{"light":"#f4f5fc","dark":"#10152e"}},"navbar":{"links":[{"href":"https://status.frankieone.com/","label":"Support"}],"primary":{"type":"button","label":"Book a Demo","href":"https://frankieone.com/book-a-demo"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/frankieone"}},"seo":{"metatags":{"canonical":"https://docs.frankieone.com","og:url":"https://docs.frankieone.com"}},"fonts":{"heading":{"family":"DM Sans","weight":800,"source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"},"body":{"family":"DM Sans","source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-TQB66YCL53"}},"errors":{"404":{"redirect":true,"title":"Sorry, we couldn't find the page you're looking for.","description":"Please try searching for a different term, use the navigation bar, or return to the homepage."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"frankieone-f5583b1b","hasAudioNarration":false,"actualSubdomain":"frankieone-f5583b1b","customDomains":["docs.frankieone.com"],"gitSource":{"type":"github","owner":"frankieone","repo":"config-api-documentation-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7d8606bddb0a059f6ecaf","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API","count":236},{"language":"default","tag":"Portal","count":188},{"language":"default","tag":"OneSDK","count":137},{"language":"default","tag":"KYC","count":131},{"language":"default","tag":"KYB","count":68},{"language":"default","tag":"KYC API Endpoints","count":50},{"language":"default","tag":"KYC V2 API","count":45},{"language":"default","tag":"About OneSDK","count":40},{"language":"default","tag":"Guide to the API","count":38},{"language":"default","tag":"Introduction","count":35}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@frankieone.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":":root{color-scheme:light dark}[data-theme=\"dark\"]{color-scheme:dark}[data-theme=\"light\"]{color-scheme:light}span[data-as=\"p\"]:not(:where([data-page=\"/\"])){color:light-dark(#000, #FFF)!important}ul{color:light-dark(#000000, #FFFFFF)!important}tr{color:light-dark(#000000, #FFFFFF)!important}p{color:light-dark(#000000, #FFFFFF)!important}code{color:#1A6CFF!important}"}],"page":{"pagePath":"api-reference/risk/get-an-entitys-risk-level-scorecard","slug":"/api-reference/risk/get-an-entitys-risk-level-scorecard","pageMetadata":{"title":"Get an entity's risk level scorecard","description":"Get current risk level of an entity from fraud or transaction monitoring.","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities/{entityId}/risk","href":"/api-reference/risk/get-an-entitys-risk-level-scorecard","autogeneratedByOpenApi":true},"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: \"Get current risk level of an entity from fraud or transaction monitoring.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get an entity's risk level scorecard","description":"Get current risk level of an entity from fraud or transaction monitoring.","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities/{entityId}/risk","href":"/api-reference/risk/get-an-entitys-risk-level-scorecard","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["043a3652-fbd1-4193-b683-7609efd92f9e"],"operationId":"fetchEntityRisk","summary":"Get an entity's risk level scorecard","description":"Get current risk level of an entity from fraud or transaction monitoring.","tags":["Risk"],"parameters":["7b50e49d-8eaa-428d-9c1f-94485323710a","85fae366-a82e-4ad3-b122-2034c0251865","f3acd24d-5f0f-4442-8b1d-c092a10aa164"],"responses":{"200":"769f3f1e-ac89-4c20-8a33-96be44ef2475","401":"3b97f8bc-a4d8-42ed-92b0-d11ca89d9ad4","404":"167dc882-5483-4551-82b5-2c19159e6451","500":"500fe536-5164-4647-9cbd-8cbaf96ce79f"},"method":"get","type":"path","servers":["a80e1185-184a-4592-b793-1976f151b90d","ff9521a6-55d5-4069-8a0c-5dc9871faa09"],"path":"/entities/{entityId}/risk","baseUrlOptions":["https://api.kycaml.frankiefinancial.io/transaction/v2","https://api.kycaml.uat.frankiefinancial.io/transaction/v2"],"title":"Get an entity's risk level scorecard","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7b50e49d-8eaa-428d-9c1f-94485323710a":{"name":"X-Frankie-CustomerID","in":"header","required":true,"schema":{"type":"string","example":"12345678-1234-1234-1234-123456789012","isRequired":true,"description":"Your Customer ID provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your Customer ID provided by FrankieOne"},"85fae366-a82e-4ad3-b122-2034c0251865":{"name":"X-Frankie-CustomerChildID","in":"header","required":false,"schema":{"type":"string","example":"87654321-4321-4321-4321-210987654321","isRequired":false,"description":"Your Customer Child ID provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your Customer Child ID provided by FrankieOne"},"f3acd24d-5f0f-4442-8b1d-c092a10aa164":{"required":true,"description":"Unique identifier of a FrankieOne entity","in":"path","name":"entityId","schema":{"type":"string","description":"Unique identifier of a FrankieOne entity\nThe unique identifier for a FrankieOne entity construct","example":"98ded7ac-2457-4bde-b27c-fcee05301262","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"769f3f1e-ac89-4c20-8a33-96be44ef2475":{"description":"Response from the GET /entity/{entityId}/risk endpoint","content":{"application/json":{"schema":{"type":"object","properties":{"overall":{"type":"object","properties":{"aml":{"type":"object","properties":{"rating":{"type":"number","description":"Numerical rating of the overall risk","example":2.3,"uniqueKey":"overall.aml.rating","typeLabel":"number"},"level":{"type":"string","description":"Level of risk as determined by the service.","example":"MEDIUM","enum":["NONE","LOW","MEDIUM","HIGH","VERY_HIGH"],"uniqueKey":"overall.aml.level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"overall.aml","typeLabel":"object"},"fraud":{"type":"object","properties":{"rating":{"type":"number","description":"Numerical rating of the overall risk","example":2.3,"uniqueKey":"overall.fraud.rating","typeLabel":"number"},"level":{"type":"string","description":"Level of risk as determined by the service.","example":"MEDIUM","enum":["NONE","LOW","MEDIUM","HIGH","VERY_HIGH"],"uniqueKey":"overall.fraud.level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"overall.fraud","typeLabel":"object"},"firstCheckDate":{"description":"Date timestamp of the First Check","type":"string","format":"datetime","example":"2006-01-02T15:04:05-0700","uniqueKey":"overall.firstCheckDate","typeLabel":"string\u003cdatetime>"},"lastUpdated":{"description":"Timestamp that the risk was last updated","type":"string","format":"datetime","example":"2006-01-02T15:04:05-0700","uniqueKey":"overall.lastUpdated","typeLabel":"string\u003cdatetime>"}},"uniqueKey":"overall","typeLabel":"object"},"factors":{"type":"object","properties":{"aml":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Risk Factor","uniqueKey":"factors.aml.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Descriptive text that details the factor","uniqueKey":"factors.aml.items.[INDEX].description","typeLabel":"string"},"rating":{"type":"number","description":"Numerical rating of the risk factor","example":3.4,"uniqueKey":"factors.aml.items.[INDEX].rating","typeLabel":"number"},"level":{"type":"string","description":"Level of risk as determined by the service.","example":"MEDIUM","enum":["NONE","LOW","MEDIUM","HIGH","VERY_HIGH"],"uniqueKey":"factors.aml.items.[INDEX].level","typeLabel":"enum\u003cstring>"},"count":{"type":"integer","description":"Count value of risk factor, evaluated based on the all data points provided for this factor","example":10,"uniqueKey":"factors.aml.items.[INDEX].count","typeLabel":"integer"}},"uniqueKey":"factors.aml.items.[INDEX]","typeLabel":"object"},"uniqueKey":"factors.aml","typeLabel":"object[]"},"fraud":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Risk Factor","uniqueKey":"factors.fraud.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Descriptive text that details the factor","uniqueKey":"factors.fraud.items.[INDEX].description","typeLabel":"string"},"rating":{"type":"number","description":"Numerical rating of the risk factor","example":3.4,"uniqueKey":"factors.fraud.items.[INDEX].rating","typeLabel":"number"},"level":{"type":"string","description":"Level of risk as determined by the service.","example":"MEDIUM","enum":["NONE","LOW","MEDIUM","HIGH","VERY_HIGH"],"uniqueKey":"factors.fraud.items.[INDEX].level","typeLabel":"enum\u003cstring>"},"count":{"type":"integer","description":"Count value of risk factor, evaluated based on the all data points provided for this factor","example":10,"uniqueKey":"factors.fraud.items.[INDEX].count","typeLabel":"integer"}},"uniqueKey":"factors.fraud.items.[INDEX]","typeLabel":"object"},"uniqueKey":"factors.fraud","typeLabel":"object[]"}},"uniqueKey":"factors","typeLabel":"object"},"issues":{"description":"Results that have been evaluated for this entity, the lack of Result object value for a Result Type indicates that a check has been done for a transaction resulting in that result being produced","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Enum of the risk issue type that flags an issue with the entity.","enum":["TXN_AML","TXN_FRAUD"],"uniqueKey":"issues.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"activities":{"type":"array","items":{"type":"string","description":"Type of the activity that was used for the check","enum":["REGISTRATION","LOGIN","FIAT_WITHDRAWAL","FIAT_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT"],"uniqueKey":"issues.items.[INDEX].activities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"issues.items.[INDEX].activities","typeLabel":"enum\u003cstring>[]"},"lastUpdated":{"description":"The datetime for when the result type of the issue was updated","type":"string","format":"datetime","example":"2006-01-02T15:04:05-0700","uniqueKey":"issues.items.[INDEX].lastUpdated","typeLabel":"string\u003cdatetime>"},"dateCreated":{"description":"The datetime for when the result type was first detected","type":"string","format":"datetime","example":"2006-01-02T15:04:05-0700","uniqueKey":"issues.items.[INDEX].dateCreated","typeLabel":"string\u003cdatetime>"}},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"overall":{"aml":{"rating":2.3,"level":"MEDIUM"},"fraud":{"rating":2.3,"level":"MEDIUM"},"firstCheckDate":"2006-01-02T15:04:05-0700","lastUpdated":"2006-01-02T15:04:05-0700"},"factors":{"aml":[{"name":"\u003cstring>","description":"\u003cstring>","rating":3.4,"level":"MEDIUM","count":10}],"fraud":[{"name":"\u003cstring>","description":"\u003cstring>","rating":3.4,"level":"MEDIUM","count":10}]},"issues":[{"type":"TXN_AML","activities":["REGISTRATION"],"lastUpdated":"2006-01-02T15:04:05-0700","dateCreated":"2006-01-02T15:04:05-0700"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3b97f8bc-a4d8-42ed-92b0-d11ca89d9ad4":{"description":"The request has failed an authorisation check. This can happen for a variety of reasons, such as an invalid or expired API key, or invalid Customer/CustomerChildIDs.\n\n* NOTE: This does not include attempts to read/write data you don't have access to - that's a 404 error (as we don't want to leak information through guessing)\n","content":{"application/json":{"schema":{"type":"object","properties":{"commit":{"type":"string","description":"Unique identifier of the Service version being used","uniqueKey":"commit","typeLabel":"string"},"requestId":{"type":"string","format":"ulid","minLength":26,"maxLength":26,"description":"Unique identifier assigned by FrankieOne for every request. Can be used for tracking down answers with technical support. Uses the ULID format (a time-based, sortable UUID) example: 01BFJA617JMJXEW6G7TDDXNSHX","uniqueKey":"requestId","typeLabel":"string\u003culid>"},"errorCode":{"type":"string","description":"FrankieOne error code","example":"CORE-5990","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","description":"Will describe the error","example":"Everything went kaflooey. Stay clam.","uniqueKey":"errorMsg","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation","issue"],"properties":{"issueLocation":{"type":"string","description":"Will describe the field or data location of the issue","example":"date_of_birth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"type":"string","description":"Description of the problem","example":"Invalid format. Must be YYYY-MM-DD","isRequired":true,"uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"commit":"\u003cstring>","requestId":"\u003cstring>","errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","issues":[{"issueLocation":"date_of_birth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"167dc882-5483-4551-82b5-2c19159e6451":{"description":"Cannot return response. In the case of a query, or reference to a specific entity/check/others, it means that the requested item was not found, or you don't have access to it. Please check your query before trying again.\n","content":{"application/json":{"schema":{"type":"object","properties":{"commit":{"type":"string","description":"Unique identifier of the Service version being used","uniqueKey":"commit","typeLabel":"string"},"requestId":{"type":"string","format":"ulid","minLength":26,"maxLength":26,"description":"Unique identifier assigned by FrankieOne for every request. Can be used for tracking down answers with technical support. Uses the ULID format (a time-based, sortable UUID) example: 01BFJA617JMJXEW6G7TDDXNSHX","uniqueKey":"requestId","typeLabel":"string\u003culid>"},"errorCode":{"type":"string","description":"FrankieOne error code","example":"CORE-5990","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","description":"Will describe the error","example":"Everything went kaflooey. Stay clam.","uniqueKey":"errorMsg","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation","issue"],"properties":{"issueLocation":{"type":"string","description":"Will describe the field or data location of the issue","example":"date_of_birth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"type":"string","description":"Description of the problem","example":"Invalid format. Must be YYYY-MM-DD","isRequired":true,"uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"commit":"\u003cstring>","requestId":"\u003cstring>","errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","issues":[{"issueLocation":"date_of_birth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"500fe536-5164-4647-9cbd-8cbaf96ce79f":{"description":"The system is presently unavailable, running in a severely degraded state or an unexpected error occurred. \nCheck the error message for details\n","content":{"application/json":{"schema":{"type":"object","properties":{"commit":{"type":"string","description":"Unique identifier of the Service version being used","uniqueKey":"commit","typeLabel":"string"},"requestId":{"type":"string","format":"ulid","minLength":26,"maxLength":26,"description":"Unique identifier assigned by FrankieOne for every request. Can be used for tracking down answers with technical support. Uses the ULID format (a time-based, sortable UUID) example: 01BFJA617JMJXEW6G7TDDXNSHX","uniqueKey":"requestId","typeLabel":"string\u003culid>"},"errorCode":{"type":"string","description":"FrankieOne error code","example":"CORE-5990","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","description":"Will describe the error","example":"Everything went kaflooey. Stay clam.","uniqueKey":"errorMsg","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation","issue"],"properties":{"issueLocation":{"type":"string","description":"Will describe the field or data location of the issue","example":"date_of_birth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"type":"string","description":"Description of the problem","example":"Invalid format. Must be YYYY-MM-DD","isRequired":true,"uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"commit":"\u003cstring>","requestId":"\u003cstring>","errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","issues":[{"issueLocation":"date_of_birth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"043a3652-fbd1-4193-b683-7609efd92f9e":{"apiKey":{"type":"apiKey","name":"apiKey","description":"API key issued by FrankieOne. This will rotate regularly.","in":"header","scopes":[]}}},"servers":{"a80e1185-184a-4592-b793-1976f151b90d":{"url":"https://api.kycaml.frankiefinancial.io/transaction/v2","description":"Production API Base URL"},"ff9521a6-55d5-4069-8a0c-5dc9871faa09":{"url":"https://api.kycaml.uat.frankiefinancial.io/transaction/v2","description":"UAT Environment API Base URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"apiKey","description":"API key issued by FrankieOne. This will rotate regularly.","in":"header","scopes":[]},"schema":{"title":"apiKey","type":"string","description":"API key issued by FrankieOne. This will rotate regularly.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"apiKey"}],"title":"apiKey"}]},"originalFileLocation":"specs/KYT-V2-Transaction-Monitoring.json"},"subdomain":"frankieone-f5583b1b","siteName":"frankieone","title":"Get an entity's risk level scorecard - frankieone","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/introduction/overview","matchLevel":4},"v1":{"href":"/api-reference/risk/get-an-entitys-risk-level-scorecard","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-06-24T02:40:40.254Z","originalFileLocation":"api-reference/risk/get-an-entitys-risk-level-scorecard.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"system\";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=\"Get current risk level of an entity from fraud or transaction monitoring.\">\u003cmeta data-mint-head name=\"application-name\" content=\"frankieone\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an entity\u0026#x27;s risk level scorecard - frankieone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get current risk level of an entity from fraud or transaction monitoring.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"frankieone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://frankieone-f5583b1b.mintlify.site/_mintlify/api/og/v2?division=Risk\u0026amp;title=Get+an+entity%27s+risk+level+scorecard\u0026amp;description=Get+current+risk+level+of+an+entity+from+fraud+or+transaction+monitoring.\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=d599e468bf1f7a0026fbeeb7e28619e404e25432f9ca2d1a41d2ed56f3c0ca9e\">\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 an entity\u0026#x27;s risk level scorecard - frankieone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get current risk level of an entity from fraud or transaction monitoring.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://frankieone-f5583b1b.mintlify.site/_mintlify/api/og/v2?division=Risk\u0026amp;title=Get+an+entity%27s+risk+level+scorecard\u0026amp;description=Get+current+risk+level+of+an+entity+from+fraud+or+transaction+monitoring.\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=d599e468bf1f7a0026fbeeb7e28619e404e25432f9ca2d1a41d2ed56f3c0ca9e\">\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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"frankieone\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A6CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/risk/get-an-entitys-risk-level-scorecard.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.frankieone.com/#organization\",\"name\":\"frankieone\",\"url\":\"https://docs.frankieone.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/light.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=21923909c20fa1b38b317371ccac6e33\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.frankieone.com#website\",\"name\":\"frankieone\",\"url\":\"https://docs.frankieone.com\",\"publisher\":{\"@id\":\"https://docs.frankieone.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard#webpage\",\"url\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard\",\"name\":\"Get an entity's risk level scorecard\",\"description\":\"Get current risk level of an entity from fraud or transaction monitoring.\",\"dateModified\":\"2026-06-24T02:40:40.254Z\",\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Fraud \u0026 AML API Endpoints\",\"item\":\"https://docs.frankieone.com/api-reference/status/check-service-status\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an entity's risk level scorecard\",\"item\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard#apireference\",\"headline\":\"Get an entity's risk level scorecard\",\"name\":\"Get an entity's risk level scorecard\",\"description\":\"Get current risk level of an entity from fraud or transaction monitoring.\",\"url\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frankieone.com/api-reference/risk/get-an-entitys-risk-level-scorecard#webpage\"},\"dateModified\":\"2026-06-24T02:40:40.254Z\",\"publisher\":{\"@id\":\"https://docs.frankieone.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"frankieone\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"frankieone","nav":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"versions":[{"version":"v2","pages":[{"title":"v2","href":"/v2/introduction/overview"}]},{"version":"v1","tabs":[{"tab":"Introduction","icon":"book","pages":[{"title":"Introduction","href":"/docs/v1/introduction/getting-started/welcome-to-frankie"}]},{"tab":"OneSDK","icon":"display-code","pages":[{"title":"OneSDK","href":"/docs/v1/onesdk/oneSDK/about-onesdk"}]},{"tab":"KYC","icon":"user-group","pages":[{"title":"KYC","href":"/docs/v1/kyc/kyc-info/overview"}]},{"tab":"KYB","icon":"briefcase","pages":[{"title":"KYB","href":"/docs/v1/kyb/overview"}]},{"tab":"Portal","icon":"credit-card","pages":[{"title":"Portal","href":"/docs/v1/portal/getting-started/overview"}]},{"tab":"Fraud","icon":"shield-halved","pages":[{"title":"Fraud","href":"/docs/v1/fraud-activity-monitoring/fraud-overview"}]},{"tab":"API","icon":"terminal","groups":[{"group":"Guide to the API","pages":[{"title":"Introduction to the API","sidebarTitle":"Introduction","icon":"book","href":"/docs/v1/api/guide-to-the-api/introduction-to-the-api"},{"group":"Getting Started","icon":"rocket","pages":[{"title":"Authentication","sidebarTitle":"","icon":"key","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/authentication"},{"title":"Errors","sidebarTitle":"","icon":"triangle-exclamation","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/errors"},{"title":"Asynchronous Calls (Background Processes)","sidebarTitle":"","icon":"clock","href":"/docs/v1/api/guide-to-the-api/getting-started/asynchronous-calls-backgrounding-processes"},{"title":"Entity Profiles Available","sidebarTitle":"Available Entity Profiles","icon":"id-card","href":"/docs/v1/api/guide-to-the-api/getting-started/entity-profiles-available-to-test-with"},{"title":"Entity extraData Key Value Pairs","sidebarTitle":"Customer Reference Numbers \u0026 Entity KVPs","icon":"hashtag","href":"/docs/v1/api/guide-to-the-api/getting-started/entity-extradata-key-value-pairs"},{"title":"Reseller Checks with Experian AU","sidebarTitle":"Reseller Checks (Experian AU)","icon":"building-columns","href":"/docs/v1/api/guide-to-the-api/getting-started/experian-reseller-abn"},{"title":"Notifications \u0026 Webhooks","sidebarTitle":"Notifications - Webhooks","icon":"bell","href":"/docs/v1/api/guide-to-the-api/getting-started/notifications-webhooks"},{"title":"Set Entity Ongoing AML Monitoring Status","sidebarTitle":"","icon":"shield","href":"/docs/v1/api/guide-to-the-api/getting-started/set-entity-ongoing-aml-monitoring-status"},{"title":"Data Source Codes","sidebarTitle":"","icon":"database","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/datasource-codes"},{"title":"Download Test Data","sidebarTitle":"","icon":"download","href":"/docs/v1/api/guide-to-the-api/getting-started/test-data"}]},{"group":"Common API Objects \u0026 Fields","icon":"cube","pages":[{"title":"Common API Objects and Fields","sidebarTitle":"Overview","icon":"cube","href":"/docs/v1/api/guide-to-the-api/common-api-objects-and-fields"},{"title":"Object IDs","sidebarTitle":"","icon":"fingerprint","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/common-api-fields-types"},{"title":"The Document Object","sidebarTitle":"","icon":"file","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/fundamentals-document-object"},{"title":"The Entity Object","sidebarTitle":"","icon":"user","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/fundamentals-entity-object"},{"title":"Key Value Pairs","sidebarTitle":"","icon":"key","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/key-value-pairs"},{"title":"RequestID","sidebarTitle":"","icon":"id-badge","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/requestid"}]},{"group":"Data Types","icon":"table","pages":[{"title":"Working with Names","sidebarTitle":"Names","icon":"signature","href":"/docs/v1/api/guide-to-the-api/data-types/names-with-different-character-sets"},{"title":"Working With Addresses","sidebarTitle":"Addresses","icon":"location-dot","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-addresses"},{"title":"Working With Country Codes","sidebarTitle":"Country Codes","icon":"globe","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-country-codes"},{"title":"Working With Support Docs","sidebarTitle":"Support Docs","icon":"file-lines","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-support-docs"},{"title":"Adding an Email Address","sidebarTitle":"","icon":"envelope","href":"/docs/v1/api/guide-to-the-api/data-types/adding-an-email-address"},{"title":"Adding a Mobile Phone Number","sidebarTitle":"","icon":"mobile","href":"/docs/v1/api/guide-to-the-api/data-types/adding-a-mobile-phone-number"}]},{"group":"Country Specific ID Document Requirements","icon":"id-card","pages":[{"title":"Requirements \u0026 Additional Fields for ID Documents","sidebarTitle":"Overview","icon":"id-card","href":"/docs/v1/api/guide-to-the-api/requirements-additional-fields-for-id-documents"},{"title":"Australian ID Documents","sidebarTitle":"Australia","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/aus-drivers-licence"},{"title":"New Zealand ID Documents","sidebarTitle":"New Zealand","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/nzl-drivers-licence"},{"title":"Chinese ID Documents","sidebarTitle":"China","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/chn-national-id"},{"title":"Mexican ID Documents","sidebarTitle":"Mexico","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/mex-national-id"},{"title":"Thai ID Documents","sidebarTitle":"Thailand","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/tha-national-id"},{"title":"India","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/ind-passport"},{"title":"Philippines","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/phi-passport"},{"title":"United States Documents","sidebarTitle":"USA","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/country-specific-documents-usa-v1"},{"title":"International","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/international-national-id"}]},{"title":"OCR Extraction Document API","sidebarTitle":"","icon":"file-lines","href":"/docs/v1/api/guide-to-the-api/ocr-extraction-document-api"},{"group":"Using the Sandbox","icon":"box","pages":[{"title":"Working with the Sandbox","sidebarTitle":"Overview","icon":"box","href":"/docs/v1/api/guide-to-the-api/working-with-the-sandbox"},{"title":"Using the Sandbox Data and API","sidebarTitle":"Sandbox Data \u0026 API","icon":"code","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/using-the-sandbox-data-and-api"},{"title":"Testing Error Scenarios","sidebarTitle":"Forcing Test Scenario Errors","icon":"bug","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/forcing-errors-in-test-scenarios"},{"title":"Typical Test Scenarios","sidebarTitle":"","icon":"vial","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/typical-test-scenarios"}]}]},{"group":"KYC API Endpoints","pages":[{"group":"status","pages":[{"title":"Service Status","openapi":"get /ruok","href":"/docs/v1/api/kyc-api-endpoints/reference/status/status-check"}]},{"group":"Document","pages":[{"title":"Create New Document.","openapi":"post /document","href":"/docs/v1/api/kyc-api-endpoints/reference/document/create-document"},{"title":"Create and Verify Document.","openapi":"POST /document/new/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/document/verify-document"},{"title":"Search For a Document","openapi":"POST /document/search","href":"/docs/v1/api/kyc-api-endpoints/reference/document/search-document"},{"title":"Retrieve Document Details","openapi":"GET /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document"},{"title":"Update Existing Document.","openapi":"POST /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/update-document"},{"title":"Delete Document.","openapi":"DELETE /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/delete-document"},{"title":"Retrieve Document Verification Check Details.","openapi":"GET /document/{documentId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document-checks"},{"title":"Retrieve Document and Scan Data","openapi":"GET /document/{documentId}/full","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document-full"},{"title":"Update and Verify Document.","openapi":"POST /document/{documentId}/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/document/update-verify-document"}]},{"group":"Entity","pages":[{"title":"Create New Entity.","openapi":"POST /entity","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-entity"},{"title":"Create Entity and Get IDV Token","openapi":"POST /entity/new/idvalidate/getToken","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-entity-get-idv-token"},{"title":"Create Entity and Push Self-Verification Link","openapi":"POST /entity/new/verify/pushToMobile","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-check-entity-push-to-mobile"},{"title":"Create and Verify Entity","openapi":"POST /entity/new/verify/{checkType}/{resultLevel}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-check-entity"},{"title":"Search for Entity","openapi":"POST /entity/search","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/search-entity"},{"title":"Retrieve Entity Details","openapi":"GET /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity"},{"title":"Update Existing Entity","openapi":"POST /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity"},{"title":"Delete Entity","openapi":"DELETE /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/delete-entity"},{"title":"Update Check Result States (Batch)","openapi":"POST /entity/{entityId}/check/{checkId}/{checkClass}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-class-results"},{"title":"Update Check Result State","openapi":"POST /entity/{entityId}/check/{checkId}/{checkClass}/{checkClassId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-class-result"},{"title":"Retrieve Entity Verification Check Details","openapi":"GET /entity/{entityId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity-checks"},{"title":"Update Entity and evaluate current results and risk without running any new checks","openapi":"POST /entity/{entityId}/evaluate","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-evaluate-entity"},{"title":"Retrieve Entity Details and Document Scan Data","openapi":"GET /entity/{entityId}/full","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity-full"},{"title":"Update Entity and Get IDV Token","openapi":"POST /entity/{entityId}/idvalidate/getToken","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-get-idv-token"},{"title":"Update Entity and Initiate IDV Process","openapi":"POST /entity/{entityId}/idvalidate/initProcess","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-init-idv-process"},{"title":"Generate Individual Verification Report","openapi":"POST /entity/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/entity-kyc-report"},{"title":"Update Entity States","openapi":"POST /entity/{entityId}/status","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-state"},{"title":"Update Entity and Push Self-Verification Link","openapi":"POST /entity/{entityId}/verify/pushToMobile","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-entity-push-to-mobile"},{"title":"Update Entity and Verify Details","openapi":"POST /entity/{entityId}/verify/{checkType}/{resultLevel}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-entity"}]},{"group":"Business","pages":[{"title":"(International) Retrieve a business profile from any country.","openapi":"POST /business/international/profile","href":"/docs/v1/api/kyc-api-endpoints/reference/business/international-business-profile"},{"title":"(International) Search for a business from any country.","openapi":"POST /business/international/search","href":"/docs/v1/api/kyc-api-endpoints/reference/business/international-business-search"},{"title":"(AUS Only) Create Business Entity and Query UBO","openapi":"POST /business/ownership/query","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-ownership-query"},{"title":"(AUS Only) Run Report(s) against a new or existing organisation entity.","openapi":"POST /business/reports","href":"/docs/v1/api/kyc-api-endpoints/reference/business/run-business-reports"},{"title":"(AUS Only) Run Report(s) against a new or existing organisation entity and produce a PDF formatted document.","openapi":"POST /business/reports/multi","href":"/docs/v1/api/kyc-api-endpoints/reference/business/run-business-reports-multi"},{"title":"(AUS Only) Make a new entity a direct associated entity of a parent organisation.","openapi":"POST /business/{entityId}/associateEntity/new","href":"/docs/v1/api/kyc-api-endpoints/reference/business/create-associate-entity"},{"title":"(AUS Only) Make an existing entity (otherId) a direct associated entity of a parent organisation (entityId), or update an existing association.","openapi":"POST /business/{entityId}/associateEntity/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/business/update-associate-entity"},{"title":"(AUS Only) Remove a previously created association between an entity (otherId) and a parent organisation (entityId).","openapi":"DELETE /business/{entityId}/associateEntity/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/business/delete-entity-association"},{"title":"(AUS Only) Retrieve previous UBO query results","openapi":"GET /business/{entityId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/business/query-ownership-checks"},{"title":"(International) List available documents in catalogue","openapi":"GET /business/{entityId}/list","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-document-catalogue"},{"title":"(AUS Only) Retrieve all the parent associations for an Individual or a Business","openapi":"GET /business/{entityId}/parentAssociations","href":"/docs/v1/api/kyc-api-endpoints/reference/business/query-parent-associations"},{"title":"(International) Get status of document order","openapi":"GET /business/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/business/order-business-document-status"},{"title":"(International) Order document from catalogue","openapi":"POST /business/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/business/order-business-document"},{"title":"(AUS Only) Subscribe or unsubscribe to continuous monitoring of business details and ownership.","openapi":"POST /business/{entityId}/subscription","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-ownership-subscription"},{"title":"(AUS Only) Run KYC/AML Checks on Organisation and/or Associated Individuals.","openapi":"POST /business/{entityId}/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/business/check-organisation"}]},{"group":"Push Notification","pages":[{"title":"Push Notification Payload","openapi":"post /your/configured/path/{requestId}","href":"/docs/v1/api/kyc-api-endpoints/reference/push-notification/notify-result"}]},{"group":"Retrieve","pages":[{"title":"(Re)retrieve Response Result.","openapi":"GET /retrieve/response/{requestId}","href":"/docs/v1/api/kyc-api-endpoints/reference/retrieve/retrieve-result"}]},{"group":"Flag","pages":[{"title":"Set Entity Blacklist State.","openapi":"POST /entity/{entityId}/flag/blacklist","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/blacklist-entity"},{"title":"Resolve Duplicate States.","openapi":"POST /entity/{entityId}/flag/duplicate/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/flag-duplicate-entity"},{"title":"Set Entity Ongoing AML Monitoring Status.","openapi":"POST /entity/{entityId}/flag/monitor","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring"},{"title":"Set Entity Watchlist State.","openapi":"POST /entity/{entityId}/flag/watchlist","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/watchlist-entity"}]}]},{"group":"Audit Log API","pages":[{"title":"Audit Log API","sidebarTitle":"Overview","icon":"clipboard-list","href":"/docs/v1/api/audit-log-api/overview"},{"title":"List audit events","openapi":"specs/fc-core-bundled_generated.yaml GET /v2/audit","href":"/docs/v1/api/audit-log-api/list-audit-events"}]},{"group":"Fraud \u0026 AML API Endpoints","pages":[{"group":"Status","pages":[{"title":"Check service status","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /ruok","href":"/api-reference/status/check-service-status"}]},{"group":"Cases","pages":[{"title":"List all cases","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entity/{entityId}/cases","href":"/api-reference/cases/list-all-cases"},{"title":"Resolve cases for an entity","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entity/{entityId}/cases","href":"/api-reference/cases/resolve-cases-for-an-entity"},{"title":"Update a case","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entity/{entityId}/cases/{caseId}","href":"/api-reference/cases/update-a-case"}]},{"group":"Transactions","pages":[{"title":"Check a transaction's risk","description":"Evaluate customer activity for fraud risk and/or money laundering risk.\nFraud risk may be associated with the customer or their device as well as the transactions that they performed. Money laundering risk is associated with financial transactions.\n\nYou supply the details of the action or transaction, originator/customer and beneficiary/counter-party, along with any additional data such as device details, location information and any additional data you feel might be relevant.\n\nThis API is extremely flexible and can be extended easily - please contact your FrankieOne account manager to discuss your options.\n\nNote: When performing a risk check for a Crypto activity type (CRYPTO_WITHDRAWAL, CRYPTO_DEPOSIT) you can provide additional information for the evaluated exchange value of the coin and value in the transaction. This can be provided by adding a `payment.alternative.value` and `payment.alternative.currencyCode` in the `activity.customerTransaction.extraData` field.\nFor example:\n```\n{\n ...\n \"extraData\": {\n \"payment.alternative.value\": \"10000.00\",\n \"payment.alternative.currencyCode\": \"USD\"\n }\n ...\n}\n```\n","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json post /transactions","href":"/api-reference/transactions/check-a-transactions-risk"}]},{"group":"Risk","pages":[{"title":"Get an entity's risk level scorecard","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities/{entityId}/risk","href":"/api-reference/risk/get-an-entitys-risk-level-scorecard"}]},{"group":"Alerts","pages":[{"title":"Fetch all alerts","description":"List all alerts from previously checked activities.","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /alerts","href":"/api-reference/alerts/fetch-all-alerts"},{"title":"Fetch entities that have had some form of transaction monitoring check completed.","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities","href":"/api-reference/alerts/fetch-entities-that-have-had-some-form-of-transaction-monitoring-check-completed"},{"title":"Fetch the details for a specific alert","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /alerts/{alertId}","href":"/api-reference/alerts/fetch-the-details-for-a-specific-alert"},{"title":"Resolve a set of alerts for a specific entity","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entities/{entityId}/alerts","href":"/api-reference/alerts/resolve-a-set-of-alerts-for-a-specific-entity"}]}]},{"group":"IDV API Endpoints","pages":[{"group":"API Reference","pages":[{"title":"Mark all data from an IDV check as captured","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/initProcess","href":"/api-reference/mark-all-data-from-an-idv-check-as-captured"},{"title":"Process an identity document photo for ocr","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/ocr","href":"/api-reference/process-an-identity-document-photo-for-ocr"},{"title":"Process results of IDV check. Optionally re-process results","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/result","href":"/api-reference/process-results-of-idv-check-optionally-re-process-results"},{"title":"Retrieve a token to use with a check","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/token","href":"/api-reference/retrieve-a-token-to-use-with-a-check"},{"title":"Provide onboarding url for hosted onesdk","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/onboarding-url","href":"/api-reference/provide-onboarding-url-for-hosted-onesdk"}]}]},{"group":"KYB Trust Agent","pages":[{"group":"Organization","pages":[{"title":"Document Analyze","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml post /v2/organizations/documents/analyze","href":"/api-reference/organization/document-analyze"},{"title":"Document Analyses Results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/analyses","href":"/api-reference/organization/document-analyses-results"},{"title":"Document Analysis Result Confirmation","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml post /v2/organizations/{entityId}/documents/{documentId}/analyses/{analysisId}/confirm","href":"/api-reference/organization/document-analysis-result-confirmation"}]}]},{"group":"KYB V2 API - Preview","pages":[{"group":"Organizations","pages":[{"title":"Organizations Lookup","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/organizations-lookup"},{"title":"Organization Profile","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/profile","href":"/api-reference/organizations/organization-profile"},{"title":"Organization Get","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}","href":"/api-reference/organizations/organization-get"},{"title":"Organization Update","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/{entityId}","href":"/api-reference/organizations/organization-update"},{"title":"Organization Ownership","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/ownership","href":"/api-reference/organizations/organization-ownership"},{"title":"Organization Requests","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/requests","href":"/api-reference/organizations/organization-requests"},{"title":"Organization Request Status","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/requests/{requestId}","href":"/api-reference/organizations/organization-request-status"}]},{"group":"Hosted URL","pages":[{"title":"Generate Hosted URL","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/hostedUrl","href":"/api-reference/hosted-url/generate-hosted-url"}]},{"group":"Reports","pages":[{"title":"Report Request","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/{entityId}/reports","href":"/api-reference/reports/report-request"}]},{"group":"Documents","pages":[{"title":"Get Attachment","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}","href":"/api-reference/documents/get-attachment"}]}]}]},{"tab":"Release Notes","icon":"code","pages":[{"title":"Release Notes","href":"/docs/v1/release-notes"}]}]}]},"basePath":"","title":"Get an entity's risk level scorecard - frankieone","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}