Yoursafe ID Claims Glossary

What this is for

Understand which identity and compliance claims are returned per scope and how to interpret those fields in your integration.

Recommended path

Start with Default Scope as the baseline, then add Platform and Profile fields only where your user consent and business requirements need them.

Core checks

Track accountstatus, screening timestamps, serial values, and scope-specific additional fields to detect meaningful identity/compliance changes.

Default Scope

This scope provides user information in a form that is designed to be non-directly identifying. The AccountID can be obtained by integrating the Yoursafe ID button on your website.

All Yoursafe Business Customers Free of charge

The claims within this scope are:

accountstatus: could be active or inactive
alias: the chosen alias by the user (if available and selected)
rawalias: base lowercase alias with normalized characters
aliasserial: unique 64-character hexadecimal string
country: ISO country name (English) based on countrycode
countrycode: ISO country code
eighteenplus: boolean (true or false) based on date of birth
ibanserial: unique 64-character hexadecimal string related to chosen IBAN
ibanserials: array of 64-character hexadecimal strings (can contain multiple values)
idverifieddate: timestamp in ISO-8601 format of latest completed identification
peplistdate: timestamp in ISO-8601 format of last PEP screening
aliastoken: <accountid>.yoursafe.id
sanctiondate: timestamp in ISO-8601 format of last sanction screening
unsanctionedlists: returns negative
eusanctionlists: returns negative
uksanctionlists: returns negative
ussanctionlists: returns negative

Usage notes

Re-check aliasserial periodically. If it changes, one or more related claims have changed as well.

For alias-related checks, a missing aliasserial usually means the user no longer uses an alias.

For account-open checks, use the presence of ibanserials as the indicator that the account is open for receiving funds.

Platform Scope

This scope provides more information about the user and is available for Merchants. Extra user consent is required for IBAN transfer and, when applicable, alias transfer. These consents are completed in one single dialogue. The aliastoken can be obtained by integrating the Yoursafe ID button.

Merchant Customers Free of charge

Additional Fields

Base included set: Everything in the Default scope.
customersince: date the customer joined Yoursafe
alias: selected alias value
rawalias: non-formatted/base alias representation
iban: primary IBAN value
ibans: array of IBAN values

Consent model

Extra user consent is required to share IBAN and, where applicable, alias values.

Profile Scope

This scope provides personal information about the user. Only PCI-compliant merchants that have signed the Profile Scope Agreement are eligible to receive these claims. Before profile claims are provided, the user must consent in two dialogues: first for IBAN (and alias where applicable), and second for explicit transfer of personal profile information.

Merchant Customers Security Certifications Required Free of charge

Additional Fields

Base included set: Everything in the Platform scope.
firstname: first name(s) of the account user
lastname: last name(s) of the account user
dateofbirth: date of birth in yyyymmdd format
placeofbirth: place of birth of the account user
documenttype: could be passport, id, drivers license, or other
documentexpiry: expiration date of the identification document
documentnumber: number of the document used in the last identification
emailaddress: user email address
selfieurl: URL to selfie image

Consent model

Extra user consent is required to share IBAN and, where applicable, alias values.

Alias Token Queries

Use JSON or DNS to check account status via alias tokens.