{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a80be8ca-e9f6-4562-9c73-1f53b2cd02ad","name":"FinIntel API Specs","description":"# Financial Compliance Solutions API – Overview\n\nThe Financial Compliance Solutions hereinafter \"FCS\" API platform provides Customer Due Diligence (CDD), sanctions screening, identity fraud verification, bank account holder verification, and case status services for Accountable / Financial or other Institutions.\n\n---\n\n## Intended Use / Compliance Responsibility\n\n**Compliance Responsibility**: FCS provides KYC, screening, verification, and risk-related information to support the institution’s onboarding process through Customer Due Diligence and risk-based processes. The institution remains responsible for interpreting results, applying its Risk Management, making onboarding or continuation decisions, and meeting any applicable regulatory reporting obligations.\n\n---\n\n## Data Availability and Match Review\n\n**Data Availability**: Screening and verification results depend on the availability, quality, and update frequency of underlying data sources and third-party providers. Potential matches, adverse media results, and risk indicators should be reviewed by the institution before final decisions are made. AI-generated summaries or interpretations are provided as decision-support outputs and should not be treated as final determinations by FCS.\n\n---\n\n## Basic Request Flow\n\n**Typical API Flow**:Submit a scan request using `/api/v2/scan`. If the scan identifies a possible match or elevated risk, the case may trigger Enhanced Due Diligence (EDD) in the frontend. Once the compliance user has reviewed the case and recorded the outcome, `/api/v2/case_status` can be used to check the case decision and whether business may continue.\n\n---\n\n## Base URL\n\n```\nhttps://api.fcsolutions.co.za\n\n ```\n\nAll endpoints are relative to this base URL. Use the `{{BASE_URL}}` variable in your Postman environment to switch between environments.\n\n---\n\n## Authentication\n\nAll FCS API endpoints require an **API Key** passed in the request header:\n\n```\nX-API-Key: {{API_KEY}}\n\n ```\n\nAdd your API key as a variable named `API_KEY` in your Postman environment (e.g., the \"Institution\" environment). This keeps your credentials secure and makes switching between environments easy.\n\n> **Security Note:** API keys are confidential credentials and must be protected. Do not expose API keys in client-side code, screenshots, public repositories, shared Postman collections, or public documentation. FCS may restrict API keys by account status, IP address, enabled service options, and available credit balance. Requests using invalid, expired, inactive, unauthorized, or IP-restricted API keys will be rejected. \n  \n\n---\n\n## Available API Endpoints\n\n| Endpoint | Method | Description |\n| --- | --- | --- |\n| /api/v2/scan | POST | CDD scan for individuals and companies (sanctions, PEP, risk scoring, Adverse Media, and can include ID Fraud Verification and Bank Account Verification in the same check) |\n| /api/v2/id_verification | POST | Standalone identity fraud verification |\n| /api/v2/bank_verification | POST | Standalone bank account holder verification |\n| /api/v2/case_status | POST | Retrieve the status of a previously submitted case |\n\n---\n\n## Available Options (option parameter)\n\nThe `option` parameter controls which datasets and products are included in a scan request. Options can be combined using a pipe-separated string (e.g., `\"C | V\"` or `\"I | P | S\"`).\n\n| Option | Name | Description |\n| --- | --- | --- |\n| B | SA FIC TFS Sanctions Only | Screens against the South African FIC Targeted Financial Sanctions (TFS) list only. Focused dataset for quick checks. |\n| C | Comprehensive Sanctions, PEP / PIP, Risk, Criminal Watchlist Check | Performs comprehensive screening against sanctions, targeted financial sanctions, PEP/PIP, criminal watchlist, adverse media, and other available risk datasets. Recommended for full CDD screening. |\n| D | Adverse Media - Basic | Performs a basic, low-cost adverse media check. This option may produce false positives or false negatives and should be reviewed as part of the institution’s risk-based process. |\n| DAI | Adverse Media - Intermediate | Performs an AI-driven adverse media check that collects available information and provides an artificial intelligence overview of identified adverse media indicators. |\n| DAE | Adverse Media - Employee | Performs an AI-driven adverse media check for employees or prospective employees. This may include FSCA debarment information, available education-related information, social media indicators, and adverse media findings. An artificial intelligence overview of the identified information is provided. |\n| I | Identity Fraud Verification | Verifies the identity number against a trusted third party data source for verification and fraud prevention purposes. Can be used standalone via `/api/v2/id_verification` or combined with option C in a scan. |\n| P | PEP / PIP Check | Screens against available local and international Politically Exposed Person (PEP) and local Public Influential Person (PIP) to identify potential risk and enhanced due diligence indicators. |\n| S | Comprehensive Sanctions Check | Screens against global sanctions, and targeted financial sanctions data sources to identify potential matches requiring review. |\n| V | Bank Account Holder Verification | Verifies that the bank account belongs to the named individual including additional verification factors in the Bank Account Verification specification. Can be used standalone via `/api/v2/bank_verification` or combined with option C in a scan. |\n| W | Crypto Wallet Screening | Screens a crypto wallet address against available high-risk, illicit activity, and sanctions-related wallet data sources. Requires `cryptoWalletAddress` parameter. |\n\n> **Note:** Not all options are enabled by default. Options are activated per institution based on your agreement with FCS. Contact \\[[info@fcsolutions.co.za](https://mailto:info@fcsolutions.co.za)\\] to enable additional options for your account. AI-generated summaries or interpretations are provided as decision-support outputs and should not be treated as final determinations by FinIntel. \n  \n\n---\n\n## Content-Type\n\nAll requests must include the following header:\n\n```\nContent-Type: application/json\n\n ```\n\n---\n\n## API Response Status Codes\n\n| HTTP Status | Meaning | Description |\n| --- | --- | --- |\n| 200 | OK | Request completed successfully. |\n| 307 | Temporary Redirect | The request was temporarily redirected. |\n| 400 | Bad Request | The request is malformed, incomplete, or contains invalid input. |\n| 401 | Unauthorized | Authentication failed or authentication details are missing, invalid, or expired. |\n| 403 | Forbidden | The request is authenticated but not permitted for the account, API key, IP address, or selected option. |\n| 404 | Not Found | The requested endpoint or resource could not be found. |\n| 407 | Proxy Authentication Required | Proxy authentication is required. |\n| 422 | Unprocessable Entity | The request was received but could not be processed due to validation or business-rule failure. |\n| 500 | Server / Provider Request Failed | An internal or upstream provider request failed. |\n| 503 | Service Unavailable | The service is temporarily unavailable or the circuit breaker is open. |\n\n---\n\n## Error Response Format\n\nError responses are returned as JSON using an `error` field.\n\n``` json\n{ \"error\": \"Forbidden\" }\n\n ```\n\n---\n\n## Authentication & Access Errors\n\n| Status | Error Message |\n| --- | --- |\n| 401 | Invalid API key |\n| 401 | API key expired |\n| 401 | API key is required |\n| 401 | API key missing |\n| 401 | Required authentication field is missing |\n| 401 | Invalid authentication details |\n| 401 | Insufficient credits |\n| 401 / 403 | User is inactive or invalid |\n| 403 | Option is not active |\n| 403 | Option not allowed |\n| 403 | This API key cannot be used from this IP address |\n\n---\n\n## Request Validation Errors\n\n| Status | Error Message |\n| --- | --- |\n| 400 / 422 | Content-Type missing |\n| 422 | Request validation failed |\n\n---\n\n## Provider / Internal Service Errors\n\n| Status | Error Message |\n| --- | --- |\n| 500 | SMS Request failed |\n| 500 | API Request failed |\n| 500 | FSCA Request failed |\n| 503 | Circuit open |\n\n---\n\n## Security Note\n\n> **Important:** API keys are confidential credentials and must be protected. Do not expose API keys in client-side code, screenshots, public repositories, shared Postman collections, or public documentation. FCS may restrict API keys by account status, IP address, enabled service options, and available credit balance. Requests using invalid, expired, inactive, unauthorized, or IP-restricted API keys will be rejected.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"43187681","team":7733300,"collectionId":"a80be8ca-e9f6-4562-9c73-1f53b2cd02ad","publishedId":"2sB2qZEhi3","public":true,"publicUrl":"https://apidocs.finintel.co.za","privateUrl":"https://go.postman.co/documentation/43187681-a80be8ca-e9f6-4562-9c73-1f53b2cd02ad","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The api specs for the screening and ID Verification services of Finintel."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/e933f3e8-f56c-41f3-a069-55caca263cc8/TG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/e933f3e8-f56c-41f3-a069-55caca263cc8/TG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.6","publishDate":"2025-07-08T22:11:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"The api specs for the screening and ID Verification services of Finintel."},"logos":{"logoLight":"https://content.pstmn.io/e933f3e8-f56c-41f3-a069-55caca263cc8/TG9nby5wbmc=","logoDark":"https://content.pstmn.io/e933f3e8-f56c-41f3-a069-55caca263cc8/TG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"Api Version2","id":"772b0fba-2060-4218-9e90-b78a67289f01","owner":"43187681","values":[],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e38e1a182310effd61d989837e5c7021e90cfef3f09f8aad1fe1f16c5517401e","favicon":"https://finintel.co.za/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Api Version2","value":"43187681-772b0fba-2060-4218-9e90-b78a67289f01"}],"canonicalUrl":"https://apidocs.finintel.co.za/view/metadata/2sB2qZEhi3"}