KYA Token

KYA and KYAPay tokens contain structured identity claims describing the human principal, the agent, and optionally the agent platform responsible for a request.

The following identity-related claims are defined for kya and kya-pay tokens.

ClaimDescription
hidA map of human identity claims (individual or organization).
apdOPTIONAL - Agent Platform identity claims.
aidAgent identity claims.
scopeOPTIONAL - String with space-separated scope values.


Human Identity (hid) Sub-Claims

The Human Identity (hid) claim contains sub-claims identifying the human principal (individual or organization) as follows.

ClaimDescription
emailEmail address associated with the human individual or organization.
birthdateOPTIONAL - Birthdate of the human principal if they are an individual.
given_nameOPTIONAL - Given name(s) or first name(s) of the human principal if they are an individual.
middle_nameOPTIONAL - Middle name(s) of the human principal if they are an individual.
family_nameOPTIONAL - Surname(s) or last name(s) of the human principal if they are an individual.
phone_numberOPTIONAL - Phone number associated with the human individual or organization.
organization_nameOPTIONAL - Name of the organization.
verifierOPTIONAL - URL of the Identity Verifier.
verifiedOPTIONAL - Boolean Verification status; true if verified, otherwise false.
verification_idOPTIONAL - Verification identifier for the verification performed, such as a GUID.

Additional sub-claims MAY be defined and used. The recipient MUST ignore any unrecognized sub-claims.



Agent Platform Identity (apd) Sub-Claims

The Agent Platform (apd) claim is optional. If present, it contains the following sub-claims.

ClaimDescription
idAgent Platform identifier.
nameOPTIONAL - Agent Platform name.
emailOPTIONAL - Email associated with agent platform. Included if the agent platform Representative has done KYA.
phone_numberOPTIONAL - Phone number associated with agent platform.
organization_nameOPTIONAL - Legal name associated with agent platform.
verifierOPTIONAL - URL of the Identity Verifier.
verifiedOPTIONAL - Boolean Verification status; true if verified, otherwise false.
verification_idOPTIONAL - Verification identifier for the verification performed, such as a GUID.

Additional sub-claims MAY be defined and used. The recipient MUST ignore any unrecognized sub-claims.



Agent Identity (aid) Sub-Claims

The Agent Identity (aid) claim describes the specific agent responsible for the request.

ClaimDescription
nameAgent name. The name should reflect the business purpose of the agent.
creation_ipThe public IP address of the system / agent that requested the token. Its value is a string containing the public IPv4 or IPv6 address from where the token request originated. It MUST be captured directly from the token request.
source_ipsOPTIONAL - Valid public IP address, or range of public IP addresses, from where the system / agent's requests to merchants / services will originate. Array of comma-separated IPv4 addresses or ranges, IPv6 addresses or ranges, or domain names resolvable to an IP address via DNS. IPv4 and IPv6 addresses can be a single IPv4 or IPv6 address or a range of IPv4 or IPv6 addresses in CIDR notation or start-and-end IP pairs.

Additional sub-claims MAY be defined and used. The recipient MUST ignore any unrecognized sub-claims.