{"info":{"_postman_id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","name":"Carefluence FlowOps Data Service","description":"

About

\n

This collection provides a suite of services powered by the Carefluence FlowOps DataService gateway. It enables identity, contact, credit, and debit order optimisation checks for South African individuals using their national identity number.

\n

Authentication

\n

All requests use OAuth 2.0 Client Credentials flow. The access token is automatically fetched and attached as a Bearer token in the Authorization header using the following environment variables:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
VariableDescription
{{OpenIDServer}}OpenID Connect server base URL
{{PublisherClientID}}OAuth2 client ID
{{PublisherClientSecret}}OAuth2 client secret
{{PublisherClientScope}}Requested OAuth2 scope
\n

Base URL

\n

All requests are sent to:

\n
{{FHIRopsBaseURL}}/DataService\n\n

Request Format

\n

All requests are POST with a JSON body containing the subject's South African identity number:

\n
{\n  \"identityNumber\": \"{{ID1}}\"\n}\n\n
\n

Available Services

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ServiceConnector CodeDescription
ID VerificationIDVerifyVerifies identity against the South African Home Affairs HANIS/NPR register
Contact VerificationSA_CONTACT_VERIFYRetrieves verified contact details, addresses, and employment history
Credit ScoreSA_CREDIT_VERIFY_INReturns a credit score and risk rating for the individual
Strike Date ServiceSTRIKE_DATE_HTTP_001Recommends optimal debit order collection dates based on income patterns
\n

Visualizer

\n

Each request includes a Postman Visualizer script that renders the response as a styled HTML card or table directly in the Postman response panel, making results easy to read at a glance.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"About","slug":"about"}],"owner":"6150292","collectionId":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","publishedId":"2sBXcGDf44","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-24T16:42:20.000Z"},"item":[{"name":"Verification API","item":[{"name":"ID Verification","event":[{"listen":"test","script":{"id":"8787fc17-d385-4ba1-aff3-44ff74ef03d0","exec":["","","// Identity Verification Document Visualizer","var template = `","","","
","
","

Identity Verification Document

","
Official Verification Record
","
"," ","
","
","
"," \"ID","
","
","
{{fullName}}
","
Identity Number
","
{{identityNumber}}
","
","
"," ","
","
","
Marital Status
","
{{maritalStatus}}
","
","
","
Date of Marriage
","
{{dateOfMarriage}}
","
","
","
Country of Birth
","
{{countryOfBirth}}
","
","
","
Deceased Status
","
{{deceasedStatus}}
","
","
","
Smart Card Issued
","
{{smartCardIssued}}
","
","
","
ID Issue Date
","
{{idIssueDate}}
","
","
","
ID Blocked Status
","
{{idNumberBlocked}}
","
","
","
Request Identifier
","
{{requestIdentifier}}
","
","
"," ","
","
Registration Status
","
","
","
{{onHANIS}}
","
HANIS Registration
","
","
","
{{onNPR}}
","
NPR Registration
","
","
"," {{#if hanisReference}}","
HANIS Reference: {{hanisReference}}
"," {{/if}}","
"," ","
","
"," {{statusIcon}}"," {{statusText}}","
","
{{responseMessage}}
","
","
"," ","
"," Response Code: {{responseCode}} | Generated by Carefluence Verification Service","
","
","`;","","function formatDate(dateStr) {"," if (!dateStr || dateStr.length !== 8) return dateStr || 'N/A';"," return dateStr.substring(0, 4) + '-' + dateStr.substring(4, 6) + '-' + dateStr.substring(6, 8);","}","","function constructVisualizerPayload() {"," var data = pm.response.json();"," var isSuccess = data.responseCode === 'BV-IVS-00000';"," "," return {"," photo: data.photo || '',"," fullName: (data.name || '') + ' ' + (data.surname || ''),"," identityNumber: data.identityNumber || 'N/A',"," maritalStatus: data.maritalStatus || 'N/A',"," dateOfMarriage: formatDate(data.dateOfMarriage),"," countryOfBirth: data.countryOfBirth || 'N/A',"," deceasedStatus: data.deceasedStatus || 'N/A',"," smartCardIssued: data.smartCardIssued || 'N/A',"," idIssueDate: formatDate(data.idIssueDate),"," idNumberBlocked: data.idNumberBlocked || 'N/A',"," requestIdentifier: data.requestIdentifier || 'N/A',"," onHANIS: data.onHANIS || 'No',"," onNPR: data.onNPR || 'No',"," hanisClass: data.onHANIS === 'Yes' ? 'badge-yes' : 'badge-no',"," nprClass: data.onNPR === 'Yes' ? 'badge-yes' : 'badge-no',"," hanisReference: data.hanisReference || '',"," responseCode: data.responseCode || 'N/A',"," responseMessage: data.responseMessage || 'N/A',"," statusClass: isSuccess ? 'status-success' : 'status-error',"," statusIcon: isSuccess ? '✓' : '✗',"," statusText: isSuccess ? 'VERIFIED' : 'VERIFICATION FAILED'"," };","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ecfd274e-4688-4f25-965d-538460d61f51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"identityNumber\":\"{{ID1}}\"}","options":{"raw":{"language":"json"}}},"url":"{{FHIRopsBaseURL}}/DataService?connectorCode=IDVerify","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"tokenName","value":""},{"key":"accessTokenUrl","value":""},{"key":"scope","value":"{{PublisherClientScope}}"},{"key":"clientSecret","value":"{{PublisherClientSecret}}"},{"key":"clientId","value":"{{PublisherClientID}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","name":"Carefluence FlowOps Data Service","type":"collection"}},"urlObject":{"path":["DataService"],"host":["{{FHIRopsBaseURL}}"],"query":[{"key":"connectorCode","value":"IDVerify"}],"variable":[]}},"response":[],"_postman_id":"ecfd274e-4688-4f25-965d-538460d61f51"},{"name":"Contact Verification","event":[{"listen":"test","script":{"id":"8787fc17-d385-4ba1-aff3-44ff74ef03d0","exec":["// Identity Verification Data Table Visualizer","var template = `","","","
","
","

Contact Verification Results

","
"," ","
","
Personal Information
","
","
","
First Name
","
{{name}}
","
","
","
Surname
","
{{surname}}
","
","
","
Identity Number
","
{{identityNumber}}
","
","
","
",""," {{#if hasResponseMessage}}","
","
{{responseMessage}}
","
"," {{/if}}","","
","
Home Phone Numbers
"," {{#if hasHomeNumbers}}"," "," "," "," "," "," {{#each homeNumbers}}"," "," "," "," "," {{/each}}","
NumberDate
{{number}}{{formattedDate}}
"," {{else}}","
No home numbers on record
"," {{/if}}","
","","
","
Work Phone Numbers
"," {{#if hasWorkNumbers}}"," "," "," "," "," "," {{#each workNumbers}}"," "," "," "," "," {{/each}}","
NumberDate
{{number}}{{formattedDate}}
"," {{else}}","
No work numbers on record
"," {{/if}}","
","","
","
Mobile Phone Numbers
"," {{#if hasMobileNumbers}}"," "," "," "," "," "," {{#each mobileNumbers}}"," "," "," "," "," {{/each}}","
NumberDate
{{number}}{{formattedDate}}
"," {{else}}","
No mobile numbers on record
"," {{/if}}","
","","
","
Addresses
"," {{#if hasAddresses}}"," "," "," "," "," "," "," "," "," "," {{#each addresses}}"," "," "," "," "," "," "," "," "," {{/each}}","
Address Line 1Address Line 2SuburbTownCodeDate
{{addressLine1}}{{addressLine2}}{{suburb}}{{town}}{{code}}{{formattedDate}}
"," {{else}}","
No addresses on record
"," {{/if}}","
","","
","
Email Addresses
"," {{#if hasEmailAddresses}}"," "," "," "," "," "," {{#each emailAddresses}}"," "," "," "," "," {{/each}}","
EmailDate
{{email}}{{formattedDate}}
"," {{else}}","
No email addresses on record
"," {{/if}}","
","","
","
Employment History
"," {{#if hasEmployers}}"," "," "," "," "," "," "," {{#each employers}}"," "," "," "," "," "," {{/each}}","
EmployerTitleDate
{{employer}}{{title}}{{formattedDate}}
"," {{else}}","
No employment history on record
"," {{/if}}","
","
","`;","","function formatDate(dateStr) {"," if (!dateStr || dateStr.length !== 8) return dateStr || 'N/A';"," var year = dateStr.substring(0, 4);"," var month = dateStr.substring(4, 6);"," var day = dateStr.substring(6, 8);"," return year + '-' + month + '-' + day;","}","","function createPayload() {"," var response = pm.response.json();"," "," var homeNumbers = (response.homeNumbers || []).map(function(item) {"," return {"," number: item.number || 'N/A',"," formattedDate: formatDate(item.date)"," };"," });"," "," var workNumbers = (response.workNumbers || []).map(function(item) {"," return {"," number: item.number || 'N/A',"," formattedDate: formatDate(item.date)"," };"," });"," "," var mobileNumbers = (response.mobileNumbers || []).map(function(item) {"," return {"," number: item.number || 'N/A',"," formattedDate: formatDate(item.date)"," };"," });"," "," var addresses = (response.addresses || []).map(function(item) {"," return {"," addressLine1: item.addressLine1 || 'N/A',"," addressLine2: item.addressLine2 || 'N/A',"," suburb: item.suburb || 'N/A',"," town: item.town || 'N/A',"," code: item.code || 'N/A',"," formattedDate: formatDate(item.date)"," };"," });"," "," var emailAddresses = (response.emailAddresses || []).map(function(item) {"," return {"," email: item.email || 'N/A',"," formattedDate: formatDate(item.date)"," };"," });"," "," var employers = (response.employers || []).map(function(item) {"," return {"," employer: item.employer || 'N/A',"," title: item.title || 'N/A',"," formattedDate: formatDate(item.date)"," };"," });"," "," return {"," name: response.name || 'N/A',"," surname: response.surname || 'N/A',"," identityNumber: response.identityNumber || 'N/A',"," responseMessage: response.responseMessage || '',"," hasResponseMessage: response.responseMessage && response.responseMessage.length > 0,"," homeNumbers: homeNumbers,"," hasHomeNumbers: homeNumbers.length > 0,"," workNumbers: workNumbers,"," hasWorkNumbers: workNumbers.length > 0,"," mobileNumbers: mobileNumbers,"," hasMobileNumbers: mobileNumbers.length > 0,"," addresses: addresses,"," hasAddresses: addresses.length > 0,"," emailAddresses: emailAddresses,"," hasEmailAddresses: emailAddresses.length > 0,"," employers: employers,"," hasEmployers: employers.length > 0"," };","}","","pm.visualizer.set(template, createPayload());"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8c34bb9c-a9c8-40c8-8324-81c5a387e808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false,"type":"text"}],"body":{"mode":"raw","raw":"{\"identityNumber\":\"{{ID1}}\"}","options":{"raw":{"language":"json"}}},"url":"{{FHIRopsBaseURL}}/DataService?connectorCode=SA_CONTACT_VERIFY","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"tokenName","value":""},{"key":"accessTokenUrl","value":""},{"key":"scope","value":"{{PublisherClientScope}}"},{"key":"clientSecret","value":"{{PublisherClientSecret}}"},{"key":"clientId","value":"{{PublisherClientID}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","name":"Carefluence FlowOps Data Service","type":"collection"}},"urlObject":{"path":["DataService"],"host":["{{FHIRopsBaseURL}}"],"query":[{"key":"connectorCode","value":"SA_CONTACT_VERIFY"}],"variable":[]}},"response":[],"_postman_id":"8c34bb9c-a9c8-40c8-8324-81c5a387e808"},{"name":"Credit Score","event":[{"listen":"test","script":{"id":"8787fc17-d385-4ba1-aff3-44ff74ef03d0","exec":["// Credit Score Report Visualizer","var template = `","","","
","
","

Credit Score Report

","
","
","
Your Credit Score
","
{{score}}
","
{{risk}}
","
","
","
"," Identity Number"," {{identityNumber}}","
","
"," Provider"," {{provider}}","
","
","
","`;","","function constructVisualizerPayload() {"," var response = pm.response.json();"," var riskLevel = response.risk || 'Unknown';"," var riskClass = 'risk-poor';"," "," if (riskLevel === 'Excellent' || riskLevel === 'Good') {"," riskClass = 'risk-excellent';"," } else if (riskLevel === 'Fair') {"," riskClass = 'risk-fair';"," }"," "," return {"," score: response.score || 'N/A',"," risk: riskLevel,"," riskClass: riskClass,"," identityNumber: response.identityNumber || 'N/A',"," provider: response.provider || 'N/A'"," };","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f901a2d0-7daa-467f-992c-b6b1d9758997","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"identityNumber\": \"{{ID1}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FHIRopsBaseURL}}/DataService?connectorCode=SA_CREDIT_VERIFY_IN","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"tokenName","value":""},{"key":"accessTokenUrl","value":""},{"key":"scope","value":"{{PublisherClientScope}}"},{"key":"clientSecret","value":"{{PublisherClientSecret}}"},{"key":"clientId","value":"{{PublisherClientID}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","name":"Carefluence FlowOps Data Service","type":"collection"}},"urlObject":{"path":["DataService"],"host":["{{FHIRopsBaseURL}}"],"query":[{"key":"connectorCode","value":"SA_CREDIT_VERIFY_IN"}],"variable":[]}},"response":[],"_postman_id":"f901a2d0-7daa-467f-992c-b6b1d9758997"},{"name":"Strike Date Service","event":[{"listen":"test","script":{"id":"8787fc17-d385-4ba1-aff3-44ff74ef03d0","exec":["// Strike Date Optimisation Report Visualizer","var template = `","","","
","
","
","

Strike Date Optimisation Report

","
South African Debit Order Analysis
","
"," ","
","

What are Strike Dates?

","

In South Africa, a strike date is the optimal day of the month for collecting a debit order from a consumer's bank account. These dates are determined by analysing income patterns, salary credit dates, and historical account behaviour. Selecting the right strike date maximises successful collections, reducing failed payments and return fees.

","
"," ","
","

Recommended Collection Days

","
"," {{#each strikeDates}}","
","
{{rankLabel}}
","
{{dayWithSuffix}}
"," {{#if isOptimal}}","
Most Optimal
"," {{/if}}","
"," {{/each}}","
","
"," ","
"," Identity Number"," {{identityNumber}}","
"," ","
","

These dates represent the recommended days of the month for debit order collection, ranked by likelihood of successful payment.

","
","
","
","`;","","function getOrdinalSuffix(day) {"," var num = parseInt(day, 10);"," if (num >= 11 && num <= 13) {"," return num + \"th\";"," }"," switch (num % 10) {"," case 1: return num + \"st\";"," case 2: return num + \"nd\";"," case 3: return num + \"rd\";"," default: return num + \"th\";"," }","}","","function createPayload() {"," var response = pm.response.json();"," "," var strikeDates = ["," {"," rank: 1,"," rankLabel: \"1st Choice\","," dayWithSuffix: getOrdinalSuffix(response.strikeDate1),"," isOptimal: true"," },"," {"," rank: 2,"," rankLabel: \"2nd Choice\","," dayWithSuffix: getOrdinalSuffix(response.strikeDate2),"," isOptimal: false"," },"," {"," rank: 3,"," rankLabel: \"3rd Choice\","," dayWithSuffix: getOrdinalSuffix(response.strikeDate3),"," isOptimal: false"," }"," ];"," "," return {"," strikeDates: strikeDates,"," identityNumber: response.identityNumber || \"N/A\""," };","}","","pm.visualizer.set(template, createPayload());"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"1235c50c-3b2f-489a-a9df-6f04a1580cc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"identityNumber\": \"{{ID1}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FHIRopsBaseURL}}/DataService?connectorCode=STRIKE_DATE_HTTP_001","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"tokenName","value":""},{"key":"accessTokenUrl","value":""},{"key":"scope","value":"{{PublisherClientScope}}"},{"key":"clientSecret","value":"{{PublisherClientSecret}}"},{"key":"clientId","value":"{{PublisherClientID}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","name":"Carefluence FlowOps Data Service","type":"collection"}},"urlObject":{"path":["DataService"],"host":["{{FHIRopsBaseURL}}"],"query":[{"key":"connectorCode","value":"STRIKE_DATE_HTTP_001"}],"variable":[]}},"response":[],"_postman_id":"1235c50c-3b2f-489a-a9df-6f04a1580cc2"}],"id":"6a1cfe23-f967-4b53-90bf-436a7aa7a3e6","description":"

Verification API

\n

This collection provides a suite of South African individual verification services powered by the Carefluence FHIRops DataService gateway. It enables identity, contact, credit, and debit order optimisation checks for South African individuals using their national identity number.

\n

Authentication

\n

All requests use OAuth 2.0 Client Credentials flow. The access token is automatically fetched and attached as a Bearer token in the Authorization header using the following environment variables:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
VariableDescription
{{OpenIDServer}}OpenID Connect server base URL
{{PublisherClientID}}OAuth2 client ID
{{PublisherClientSecret}}OAuth2 client secret
{{PublisherClientScope}}Requested OAuth2 scope
\n

Base URL

\n

All requests are sent to:

\n
{{FHIRopsBaseURL}}/DataService\n\n

Request Format

\n

All requests are POST with a JSON body containing the subject's South African identity number:

\n
{\n  \"identityNumber\": \"{{ID1}}\"\n}\n\n
\n

Available Services

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ServiceConnector CodeDescription
ID VerificationIDVerifyVerifies identity against the South African Home Affairs HANIS/NPR register
Contact VerificationSA_CONTACT_VERIFYRetrieves verified contact details, addresses, and employment history
Credit ScoreSA_CREDIT_VERIFY_INReturns a credit score and risk rating for the individual
Strike Date ServiceSTRIKE_DATE_HTTP_001Recommends optimal debit order collection dates based on income patterns
\n

Visualizer

\n

Each request includes a Postman Visualizer script that renders the response as a styled HTML card or table directly in the Postman response panel, making results easy to read at a glance.

\n","_postman_id":"6a1cfe23-f967-4b53-90bf-436a7aa7a3e6","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"tokenName","value":""},{"key":"accessTokenUrl","value":""},{"key":"scope","value":"{{PublisherClientScope}}"},{"key":"clientSecret","value":"{{PublisherClientSecret}}"},{"key":"clientId","value":"{{PublisherClientID}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","id":"9240ecd1-b6be-437f-95f0-b1c7221b2b81","name":"Carefluence FlowOps Data Service","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"tokenName","value":""},{"key":"accessTokenUrl","value":""},{"key":"scope","value":"{{PublisherClientScope}}"},{"key":"clientSecret","value":"{{PublisherClientSecret}}"},{"key":"clientId","value":"{{PublisherClientID}}"},{"key":"grant_type","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"72e2d5ce-1744-4c75-b29f-9ef0a527f746","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"670e90a1-17b5-4f22-b727-f61d46e59091","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}]}