Identity
34 endpoints
What the platform knows about a phone number or an email address that has been sent a one-time code: whether it is verified, whether the outstanding code has expired, how many attempts have failed, and the code itself.
A record is keyed by the contact detail. It exists before any customer does, a code is sent to a phone number, and only later does that number belong to somebody. So this is not a view of a customer, and there is no cust_ to read it by.
The read includes the live code. Anyone holding it can pass the verification, which is why this whole collection is platform administrators only.
Resetting clears the failed attempts and issues a new code. That is what to do for someone locked out by failed attempts, or whose code never arrived.
GET
/contact-verificationsList contact verificationsRBAC
PATCH/contact-verificationsUpdate contact verificationsADT
RBAC
POST/customer-api-keysCreate customer API keysADT
RBAC
POST/kyc-identificationsCreate KYC identificationsADT
RBAC
GET/users/{userId}Get userRBAC
GET/usersList usersRBAC
POST/usersCreate usersADT
RBAC
PATCH/users/{userId}Update userADT
RBAC
GET/roles/{roleId}Get roleRBAC
GET/rolesList rolesRBAC
POST/rolesCreate rolesADT
RBAC
PATCH/roles/{roleId}Update roleADT
RBAC
GET/oidc-providers/{oidcProviderId}Get OIDC providerRBAC
GET/oidc-providersList OIDC providersRBAC
POST/oidc-providersCreate OIDC providersADT
RBAC
PATCH/oidc-providers/{oidcProviderId}Update OIDC providerADT
RBAC
GET/sessionsList sessionsRBAC
POST/sessionsCreate sessionsADT
RBAC
PATCH/sessionsUpdate sessionsADT
RBAC
POST/auth-tokensCreate auth tokensADT
RBAC
GET/api-keys/{apiKeyId}Get API keyRBAC
GET/api-keysList API keysRBAC
POST/api-keysCreate API keysADT
RBAC
PATCH/api-keys/{apiKeyId}Update API keyADT
RBAC
GET/auth-types/{authTypeId}Get auth typeRBAC
GET/auth-typesList auth typesRBAC
POST/auth-typesCreate auth typesADT
RBAC
PATCH/auth-types/{authTypeId}Update auth typeADT
RBAC
POST/oidc/.extension/sso/launchOIDC sso launchGET/oidc/.well-known/openid-configurationOIDC discoveryGET/oidc/oauth2/authoriseOIDC authoriseGET/oidc/oauth2/jwksOIDC jwksPOST/oidc/oauth2/tokenOIDC tokenGET/oidc/oauth2/userinfoOIDC user info