Yoursafe ID offers a simple yet powerful JSON interface that allows businesses and financial institutions to verify the status of YOU account holders without needing to know the personal identity of the user. This system ensures that the identity of the individual has been verified by Yoursafe while preserving privacy. By using the JSON interface, businesses can retrieve non-personalized data about the account status, compliance checks, and more.
The JSON interface allows platforms to ensure that the Yoursafe YOU customer is in good standing and compliant with relevant regulations. This is achieved through continuous checks, including daily sanction and PEP screenings. Additionally, the JSON interface helps businesses remain informed about changes in account status, such as if a customer leaves Yoursafe.
To access information through the JSON interface, a unique Yoursafe aliastoken is required. This token acts as an identifier for the account and is used to query account-related data.
Businesses can obtain the default scope of a Yoursafe YOU account by making a request to a URL in the following format:
https://<aliastoken>.yoursafe.id/?json=1
This URL returns a JSON object containing relevant, non-personal account information.
The JSON response from a query includes the following key data fields:
aliastoken
|
The unique identifier for the alias. |
aliasserial
|
A serial associated with the account that changes when there is a significant modification to the account. |
accountstatus
|
Indicates whether the account is active or inactive. |
country
|
Specifies the country of residence of the Yoursafe YOU customer. |
countrycode
|
The ISO-3166 country code for the customer's country of residence. |
eighteenplus
|
A Boolean value indicating whether the customer is over 18. The value could be True or False |
idverifieddate
|
The date of the last ID verification. Format YYYY-MM-DDTHH24:MM:SSZ |
peplistdate
|
The timestamp of the last check against the PEP list. Format YYYY-MM-DDTHH24:MM:SSZ |
sanctiondate
|
The timestamp of the last check against the sanction list. Format YYYY-MM-DDTHH24:MM:SSZ |
uksanctionlists
|
Returns "Negative" if the customer is not listed on any known UK sanction lists. |
unsanctionlists
|
Returns "Negative" if the customer is not listed on any known UN sanction lists. |
ussanctionlists
|
Returns "Negative" if the customer is not listed on any known US sanction lists. |
eusanctionlists
|
Returns "Negative" if the customer is not listed on any known EU sanction lists. |
ibanserials
|
Serial numbers of IBANs associated with the Yoursafe YOU customer. |
A JSON query to https://xyz123.yoursafe.id/?json=1 might return:
{
"aliastoken": "xyz123.yoursafe.id",
"accountserial": "6942a9f1d87d1a9e218b940af92dfdd2f0323bf25004b24a757e0e9ab4b9582a",
"accountstatus": "active",
"country": "Netherlands",
"countrycode": "NL",
"eighteenplus": true,
"idverifieddate": "2022-07-21T06:27:33Z",
"peplistdate": "2023-05-24T10:41:38Z",
"sanctiondate": "2023-05-24T10:41:38Z",
"uksanctionlists": "Negative",
"unsanctionlists": "Negative",
"ussanctionlists": "Negative",
"eusanctionlists": "Negative",
"aliasserials": [
"a56af59614c9c543eac7b3c6300f44494972f0e3f3c0ded33ffc005aeb9491b5"
],
"ibanserials": [
"a8999c4cbf0a1a67a3d0d4cf9cb7ea2b9a7d66301a93941f9ac2079597de39e1"
]
}
The JSON interface simplifies compliance processes by enabling businesses to:
Using the JSON query interface from Yoursafe ID allows businesses to access essential data about YOU accounts efficiently, without releasing personal attributes of the YOU account holder. This method helps platforms ensure compliance and maintain secure interactions while respecting user privacy.