{ "openapi": "3.0.1", "info": { "title": "Identity Verification API - Global KYC, AML and Age Checks", "description": "Verify a person against government registries, credit bureaus, telco and electoral data in over 100 countries, and screen them against global sanctions, PEP and adverse media watchlists. One row per service result, with match scores, safe harbour outcome and the elements that matched.", "version": "0.1", "x-build-id": "1gtLRLJy2PMD4fdWz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~global-identity-verification-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-global-identity-verification-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~global-identity-verification-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-global-identity-verification-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~global-identity-verification-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-global-identity-verification-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "people": { "title": "People to verify", "type": "array", "description": "One object per person, using this provider's own field names. Recognised keys are firstName, middleName, lastName, dateOfBirth (YYYY-MM-DD), gender, and the address lines addressElement1 to addressElement5. Identifiers go in identityVariables, for example {\"phoneNo\": \"0487787402\"} or {\"nationalIDNo\": \"...\"}, and are also accepted written flat on the person. A person may carry its own countryCode, service list and clientReference to override the run defaults." }, "countryCode": { "title": "Country", "type": "string", "description": "The two letter country code the checks run against, for example AU, GB, US, NZ, SG or IN. Use All for the global services such as watchlist screening. This provider selects its data sources by country, so this decides which sources are available. A person can override it with its own countryCode.", "default": "AU" }, "services": { "title": "Services to run", "type": "array", "description": "The provider's own service names, one per line, for example Australia Residential, Australia Credit Bureau, Australia Driver Licence, Australia Passport or Watchlist AML. Naming more than one is a composite search and is billed for every service it names. Your account has to be contracted for a service before it will answer.", "items": { "type": "string" } }, "username": { "title": "Account username", "type": "string", "description": "Your own account username for this provider. Bring your own credentials: nothing is shared between runs and the credentials are never written to the dataset." }, "password": { "title": "Account password", "type": "string", "description": "Your own account password for this provider. It is exchanged once per run for a session token, which is what the verification calls carry." }, "environment": { "title": "Environment", "enum": [ "production", "sandbox" ], "type": "string", "description": "Which of the provider's two environments to call. Sandbox checks against test identities rather than live data and is billed differently, and its credentials are a separate account from production.", "default": "production" }, "clientReference": { "title": "Your reference", "type": "string", "description": "A string of your own that is sent with every request and returned on every row, so a result can be tied back to the case or batch it came from. A person can override it with its own clientReference." }, "skipNotVerified": { "title": "Only keep verified results", "type": "boolean", "description": "Leave results that came back with no match out of the dataset entirely. Off by default, because a no match is a real answer and is not charged for.", "default": false }, "baseUrl": { "title": "Custom host", "type": "string", "description": "Overrides the host outright. Leave empty unless your account was issued a dedicated hostname, in which case the environment setting is ignored." }, "maxResults": { "title": "Maximum rows", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many rows. Rows are charged individually, so this is the ceiling on what a run can cost.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 600, "type": "integer", "description": "How fast to call the provider. Lower this if your contract has a tighter rate ceiling than the default.", "default": 60 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }