--- updatedAt: 2026-08-09T16:52:05.000Z agentTools: projectIndex: https://docs.zerohash.com/llms.txt --- # Get participant user sanction screening info This endpoint returns Participant User sanction screening info. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "zerohash API", "description": "\n### Authentication\n\nzerohash Uses HMAC SHA-256 verification to ensure the authenticity of API requests, follow instructions by link [https://docs.zerohash.com/reference/api-authentication](https://docs.zerohash.com/reference/api-authentication)\n\nDownload zerohash OpenAPI Schema as JSON\n", "version": "1.7.0" }, "servers": [ { "url": "https://api.cert.zerohash.com", "description": "Certification API server" } ], "x-readme": { "proxy-enabled": false }, "tags": [ { "name": "Entity Participants", "description": "Create and Manage Entity Participants" } ], "paths": { "/participant/{participant_code}/sanction_screening_info/cp_bo": { "get": { "tags": [ "Entity Participants" ], "summary": "Get participant user sanction screening info", "description": "This endpoint returns Participant User sanction screening info.", "parameters": [ { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/Timestamp" }, { "$ref": "#/components/parameters/ParticipantCodePath" } ], "responses": { "200": { "description": "Successfully retrieved participant user (CPBO) sanction screening information. Including screening status and compliance results for controlling persons and beneficial owners.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetParticipantCPBOSanctionScreeningInfoResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code400" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code404" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code500" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code503" } } } } } } } }, "security": [ { "apiKey": [], "apiPassphrase": [] } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "description": "Your API public key. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for how to obtain keys.", "in": "header", "name": "X-SCX-API-KEY" }, "apiPassphrase": { "type": "apiKey", "description": "The passphrase associated with your API key, set when the key was created.", "in": "header", "name": "X-SCX-PASSPHRASE" } }, "parameters": { "Signature": { "name": "X-SCX-SIGNED", "in": "header", "description": "HMAC-SHA256 signature of the request, base64-encoded. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for the exact signing formula.", "required": true, "schema": { "type": "string" } }, "Timestamp": { "name": "X-SCX-TIMESTAMP", "in": "header", "description": "Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.", "required": true, "schema": { "type": "string", "example": "1678901234" } }, "ParticipantCodePath": { "name": "participant_code", "in": "path", "description": "Unique participant identifier. Always 6 uppercase alphanumeric characters.", "required": true, "schema": { "type": "string", "pattern": "^[A-Z0-9]{6}$", "example": "ABCDEF" } } }, "schemas": { "Code400": { "type": "object", "description": "Request was rejected by validation or a downstream service. `errors` is an array of human-readable messages; each entry describes a single validation failure or business-rule violation.", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "string" }, "example": [ "body/amount must be >= 0", "body/asset is required" ] } } }, "Code403": { "type": "object", "description": "Authentication or authorization failed. `error` is always `true`; `message` explains which check failed (missing API key, bad signature, insufficient permission, etc.).", "required": [ "error", "message" ], "properties": { "error": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "This api key does not have write permission to this endpoint" } } }, "Code404": { "type": "object", "description": "The requested resource does not exist or is not visible to the caller.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Not Found" } } }, "Code500": { "type": "object", "description": "An unexpected error occurred on the server. The request can be retried after a short delay, but the same inputs may reproduce the error.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Internal Server Error" } } }, "Code503": { "type": "object", "description": "A downstream dependency was unavailable, timed out, or returned a retryable error. Safe to retry; the response carries a `zh-allow-retry: true` header.", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Service Unavailable" } } }, "GetParticipantCPBOSanctionScreeningInfoResponse": { "type": "object", "properties": { "users": { "type": "object", "description": "Sanction Screening info of the Control Persons and Beneficial Owners, keyed by user_code", "additionalProperties": { "type": "object", "properties": { "user_code": { "type": "string", "description": "The user code of the Control Person or Beneficial Owner" }, "name": { "type": "string", "description": "Full name of the participant" }, "is_beneficial_owner": { "type": "boolean", "description": "Indicates if the user is a beneficial owner" }, "email": { "type": "string", "description": "Email of the participant", "example": "mail@mail.com" }, "address_one": { "type": "string", "description": "First line for the customer's address.\n\nNotes:\n- The regular maximum length is 80 characters.\n- If the platform is on the vendor reliance track, the maximum length increases to 200 characters.\n- PO Box addresses are not accepted.", "example": "123 Main St." }, "address_two": { "type": "string", "description": "Extra information, like an apartment or suite number.\n\nNotes:\n- The regular maximum length is 50 characters.\n- If the platform is on the vendor reliance track, the maximum length increases to 200 characters.\n- PO Box addresses are not accepted.", "example": "Suite 1000" }, "city": { "type": "string", "description": "The city minor resides in", "example": "Chicago" }, "postal_code": { "type": "string", "description": "Postal, or zip code, of the business, in the format \"min 4 characters, no leading or trailing spaces\" for non-US postal code or <5digits>-<4digits> for US zip code, e.g. 77777 or 77777-7777", "example": "12345" }, "jurisdiction_code": { "type": "string", "example": "US-IL", "description": "The ISO 3166-2 subdivision code that the customer resides in" }, "date_of_birth": { "type": "string", "description": "Date of birth of the participant user", "example": "1985-09-02" }, "kyc_timestamp": { "type": "number", "description": "The UNIX timestamp (in milliseconds) when KYC was passed. This timestamp must be no greater than one (1) year in the past and one (1) day in the future", "example": 1603378501286 }, "sanction_screening_timestamp": { "type": "number", "description": "The UNIX timestamp (in milliseconds) when KYC was passed. This timestamp must be no greater than one (1) year in the past and one (1) day in the future", "example": 1603378501286 } } } } } } } } } ```