Scopes
Les scopes disponibles, les claims qu'ils retournent et leur usage.
Un scope est un ensemble de claims, ou une option de parcours. Demandez le minimum nécessaire à votre cas d’usage : les scopes sensibles nécessitent une justification lors de la demande d’accès.
Les claims demandés par scope sont fournis s’ils sont disponibles ; sinon ils sont absents et aucune erreur n’est générée. Cette liste correspond au guide d’implémentation V2 (section 6.2) ; le guide fait foi, et A3BC peut adapter certains comportements pour un RP donné.
Identité de base
L’état civil d’une personne physique, généralement extrait d’une pièce d’identité officielle.
| Scope | Claims | Description |
|---|---|---|
profile | given_name, family_name, gender, birthdate | Profil de base. Ce scope ne permet pas de savoir comment les claims ont été vérifiés. |
private:personSensible | given_name, family_name, gender, birthdate, private:birthplace, private:birthcountry, private:person_verified, private:nationality, private:married_name, private:person.credential.expiration | Attributs d’état civil extraits d’un document d’identité officiel. |
private:person.inseeSensible | private:person + private:birthplace.insee, private:birthcountry.insee | Ajoute au scope private:person les codes INSEE du lieu et du pays de naissance. |
Autres attributs
| Scope | Claims | Description |
|---|---|---|
email | email, email_verified, private:email.credential.issuance, private:email.credential.expiration | Adresse e-mail. email_verified vaut true si elle a été vérifiée par OTP. |
phone | phone_number, phone_number_verified, private:phone_number.credential.issuance, private:phone_number.credential.expiration | Numéro de téléphone. phone_number_verified vaut true s’il a été vérifié par OTP. |
address | address, private:address_details, private:address_verified, private:address.credential.issuance, private:address.credential.expiration | Adresse postale de l’utilisateur. |
private:bankaccountSensible | private:bankaccount, private:bankaccount_verified, private:bankaccount.credential.issuance, private:bankaccount.credential.expiration | Coordonnées bancaires. |
private:ssn.frSensible | private:ssn, private:ssn_key, private:ssn_verified, private:ssn.credential.issuance, private:ssn.credential.expiration | Numéro de sécurité sociale français. |
Documents
Ces scopes ajoutent des claims contenant l’URL d’un document, à récupérer avec l’API document. Les scopes private:doc.* donnent des documents vérifiés.
| Scope | Claims | Description |
|---|---|---|
private:doc.idSensible | private:doc.id, private:doc.id.hash, private:person_verified | Copie numérique du document d’identité utilisé pour vérifier l’identité. |
private:doc.addressSensible | private:doc.address, private:doc.address.hash, private:address_verified | Document ayant servi à vérifier l’adresse. |
private:doc.bankaccountSensible | private:doc.bankaccount, private:doc.bankaccount.hash, private:bankaccount_verified | Relevé d’identité bancaire vérifié. |
private:doc.ssnSensible | private:doc.ssn, private:doc.ssn.hash, private:ssn_verified | Document dont a été extrait le numéro de sécurité sociale. |
private:doc.photoSensible | private:doc.photo, private:doc.photo.hash, private:photo_verified, private:photo.credential.issuance, private:photo.credential.expiration | Uniquement la photo de l’utilisateur (rapprochée d’une pièce d’identité officielle). |
Scopes techniques
Ils pilotent le déroulement de la transaction.
| Scope | Claims | Description |
|---|---|---|
openid | — | Obligatoire. Retourne un id_token standard contenant les claims demandés. |
private:method.qrcode | — | L’utilisateur lance le consentement par QR code. Peut être refusé pour votre Relying Party : le choix est alors fait par l’IdP. |
private:method.identifier | — | L’utilisateur lance le consentement par identifiant (login). Peut être refusé pour votre Relying Party. |
private:delayed_sharing | private:delayed_sharing | Active le partage différé : le claim renvoie l’URL de l’API de partage différé. Voir la section dédiée. |