PII Sharing
šļø Last updated on Oct 14, 2024
This guide is subject to be updated based on current implementation.
Zero Hash is enabling a new set of endpoints that allows platforms to access participantsā PII information. This document explains how to access such information via these new endpoints.
Target to go live: October 16th 2024
Participant data categories
The data has been divided into three buckets:
| Field | Non PII/basic_info | Sanction Screening/sanction_screening_info | Full Sharing/full_info |
|---|---|---|---|
| participant_code | ā | ā | ā |
| status | ā | ā | ā |
| action | ā | ā | ā |
| user_email | ā | ā | |
| participant_type | ā | ā | ā |
| name | ā | ā | ā |
| first_name | ā | ā | |
| last_name | ā | ā | |
| ā | ā | ā | |
| contact_number | ā | ā | |
| website | ā | ā | |
| address_one | ā | ā | |
| address_two | ā | ā | |
| city | ā | ā | |
| state_or_province | ā | ā | |
| postal_code | ā | ā | |
| id_number_type | ā | ||
| id_number | ā | ||
| non_us_other_type | ā | ||
| id_issuing_authority | ā | ||
| date_established | ā | ā | |
| legal_name | ā | ā | |
| entity_type | ā | ā | |
| state_or_province_of_organization | ā | ā | |
| date_of_birth | ā | ā | |
| submission_method | ā | ā | ā |
| signed_timestamp | ā | ā | ā |
| created_at | ā | ā | ā |
| last_updated | ā | ā | ā |
| non_us_entity_tax_id | ā | ||
| tax_id | ā | ||
| platform_updated_at | ā | ā | |
| lock_reason | ā | ||
| unlock_reason | ā | ||
| disable_reason | ā | ||
| close_reason | ā | ||
| divest_reason | ā | ||
| kyc | ā | ||
| kyc_timestamp | ā | ā | |
| sanction_screening_timestamp | ā | ā | |
| sanction_screening | ā | ||
| idv | ā | ||
| liveness_check | ā | ||
| kyc_participant_track | ā | ā | |
| jurisdiction_updated_at | ā | ā | |
| ach_issue_detail | ā | ||
| employment_status | ā | ||
| industry | ā | ||
| source_of_funds | ā | ||
| signed_agreements | ā | ||
| onboarded_location | ā | ||
| kyc_tier | ā | ||
| salary | ā | ||
| savings_and_investments | ā | ||
| investor_category | ā | ||
| ip_address | ā | ||
| appropriateness_test_results | ā | ||
| kyc_attempts | ā | ||
| subdomain | ā | ā | |
| citizenship_code | ā | ||
| jurisdiction_code | ā | ā | ā |
These three buckets are the sets of information that can be accessed via the new endpoints.
API Endpoints
Accessing these three sets of information requires your platform to be approved to access the sensitive information.
Restricted access
When trying to access an endpoint that has not been enabled to your platform, the following is the error response to the API call:
| HTTP Code | Message | Description |
|---|---|---|
| 403 Forbidden | You are not authorized to access the requested resource. | Ensure your API keys, credentials, and request URL are valid. Also, check if your IP address is allow-listed in our platform. Lastly, please confirm the resource you're trying to access belongs to your platform. |
Source: Error Handling
If you want access to these endpoints, follow the steps on Required Settings section of this document.
Basic information
To access basic information from a participant, integrate the following API call:
GET /participant/{participant_code}/basic_info
This will return the following payload:
{
"message": {
"participant_code": "CUST01",
"participant_status": "approved",
"action": "approved",
"participant_type": "individual",
"name": "robert test",
"email": "[email protected]",
"submission_method": "web",
"signed_timestamp": 1603378501286,
"created_at": 1603378501286,
"last_updated": 1680643465352,
"jurisdiction_code": "US-IL"
}
}
Sanction screening information
In order to access the PII to be able to produce a sanction screening check, integrate the following API call:
GET /participant/{participant_code}/sanction_screening_info
This will return the following payload:
{
"message": {
"participant_code": "CUST01",
"status": "approved",
"action": "approved",
"user_email": "[email protected]",
"participant_type": "individual",
"name": "robert test",
"first_name": "robert",
"last_name": "test",
"email": "[email protected]",
"contact_number": "15557778888",
"website": "www.test.com",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"date_established": "1985-09-02",
"legal_name": "Legal Name",
"entity_type": "partnership",
"state_or_province_of_organization": "IL",
"date_of_birth": "1985-09-02",
"submission_method": "web",
"signed_timestamp": 1603378501286,
"created_at": 1603378501286,
"last_updated": 1680643465352,
"platform_updated_at": 1603378501286,
"sanction_screening_timestamp": 1603378501286,
"kyc_participant_track": "track",
"jurisdiction_updated_at": 1603378501286,
"subdomain": "subdomain",
"jurisdiction_code": "US-IL"
}
}
Full set of information
If your platform has been approved to access the full set of participant information, then it must integrate the following API call:
GET /participant/{participant_code}/full_info
This will return the following payload:
{
"message": {
"participant_code": "CUST01",
"status": "approved",
"action": "approved",
"action_reason": "compliance_issue",
"user_email": "[email protected]",
"participant_type": "individual",
"name": "robert test",
"first_name": "robert",
"last_name": "test",
"email": "[email protected]",
"contact_number": "15557778888",
"website": "www.test.com",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"date_established": "1985-09-02",
"legal_name": "Legal Name",
"entity_type": "partnership",
"state_or_province_of_organization": "IL",
"date_of_birth": "1985-09-02",
"submission_method": "web",
"signed_timestamp": 1603378501286,
"created_at": 1603378501286,
"last_updated": 1680643465352,
"platform_updated_at": 1603378501286,
"kyc_timestamp": 1603378501286,
"sanction_screening_timestamp": 1603378501286,
"kyc_participant_track": "track",
"jurisdiction_updated_at": "2012-03-29",
"kyc_tier": "tier",
"subdomain": "subdomain",
"jurisdiction_code": "US-IL",
"id_number": "123456789",
"id_number_type": "us_border_crossing_card",
"non_us_other_type": null,
"id_issuing_authority": null,
"non_us_entity_tax_id": null,
"tax_id": "000-00-0000",
"kyc": "pass",
"sanction_screening": "pass",
"idv": "pass",
"liveness_check": "pass",
"employment_status": "full_time",
"industry": "adult_entertainment",
"source_of_funds": "salary",
"signed_agreements": [
{
"type": "user_agreement",
"region": "us",
"signed_timestamp": 1603378501286
}
],
"onboarded_location": "US-FL",
"salary": "under_3500",
"savings_and_investments": "under_10000",
"investor_category": "restricted",
"ip_address": "10.132.5.50",
"appropriateness_test_results": [
{
"result": "pass",
"timestamp": "1985-09-02"
}
],
"kyc_attempts": 1,
"citizenship_code": "US"
}
}
Request for approval
By default, every platform has access to the basic level of information. This set doesnāt contain any private information of the participants.
If your platform needs to access a higher level of information, contact your technical account manager to request access. There will be a subsequent due diligence process from our compliance team before we can enable you to access the rest of the endpoints.
Updated about 1 year ago