{ "opencollection": "1.0.0", "info": { "name": "Core V2 Audit Individual Entities API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "items": [ { "info": { "name": "Individual Entities", "type": "folder" }, "items": [ { "info": { "name": "Create an individual entity", "type": "http" }, "http": { "method": "POST", "url": "https://api.uat.frankie.one/v2/individuals", "headers": [ { "name": "api_key", "value": "" }, { "name": "X-Frankie-CustomerID", "value": "" }, { "name": "X-Frankie-CustomerChildID", "value": "" }, { "name": "X-Frankie-Channel", "value": "" }, { "name": "X-Frankie-Username", "value": "" } ], "params": [ { "name": "level", "value": "", "type": "query", "description": "Determines what level of detail to return in the response\n - id: Return just an id\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and data in base64 format" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "docs": "Creates an Individual entity object which can be used to store data about an individual. You can optionally include documents, attachments, references etc. to the entity.\nInformation stored in an entity object can be used to verify the individual against external data sources for the purposes of eKYC, or in other verifications supported by FrankieOne." }, { "info": { "name": "Get an individual entity", "type": "http" }, "http": { "method": "GET", "url": "https://api.uat.frankie.one/v2/individuals/:entityId", "headers": [ { "name": "api_key", "value": "" }, { "name": "X-Frankie-CustomerID", "value": "" }, { "name": "X-Frankie-CustomerChildID", "value": "" }, { "name": "X-Frankie-Channel", "value": "" }, { "name": "X-Frankie-Username", "value": "" } ], "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Unique FrankieOne identifier for an entity" }, { "name": "level", "value": "", "type": "query", "description": "Determines what level of detail to return in the response\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and images as base64" } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "docs": "Retrieve all the information of the Individual Entity with the matching entity ID." }, { "info": { "name": "Update an individual entity", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.uat.frankie.one/v2/individuals/:entityId", "headers": [ { "name": "api_key", "value": "" }, { "name": "X-Frankie-CustomerID", "value": "" }, { "name": "X-Frankie-CustomerChildID", "value": "" }, { "name": "X-Frankie-Channel", "value": "" }, { "name": "X-Frankie-Username", "value": "" } ], "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Unique FrankieOne identifier for an entity" }, { "name": "level", "value": "", "type": "query", "description": "Determines what level of detail to return in the response\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and images as base64" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "docs": "Update any of the information of the Individual Entity with the matching entity ID." }, { "info": { "name": "Delete an individual entity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.uat.frankie.one/v2/individuals/:entityId", "headers": [ { "name": "api_key", "value": "" }, { "name": "X-Frankie-CustomerID", "value": "" }, { "name": "X-Frankie-CustomerChildID", "value": "" }, { "name": "X-Frankie-Channel", "value": "" }, { "name": "X-Frankie-Background", "value": "" }, { "name": "X-Frankie-Username", "value": "" } ], "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Unique FrankieOne identifier for an entity" }, { "name": "level", "value": "", "type": "query", "description": "Determines what level of detail to return in the response\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and images as base64" } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "docs": "Delete Individual Entity with the matching entity ID." } ] } ], "bundled": true }