Retrieve a person's profile
Given the SlashID Access Token obtained during signin, this endpoint returns a person's profile.
This endpoint will work only if openid
was granted as a scope for the Access Token. The information included in the response depends on the scopes requested. For example, a scope of just openid
may return less information than a scope of openid profile email
.
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
- sub string
The subject granted to the token, as a person ID.
- iss string
The access token issuer.
- aud string
The audience granted to th token, that is, the OAuth2 client ID.
- org_id string
The SlashID organization ID granted to the token.
- email string
The email address of the person. Only present if the authorization request included scope
email
. - email_verified boolean
Is
true
if the ownership of the email address was verified.false
otherwise. - phone_number string
The phone number of the person. Only present if the authorization request included scope
phone
. - phone_number_verified boolean
Is
true
if the ownership of the phone number was verified.false
otherwise. - username string
The username of the person. Only present if the authorization request included scope
username
.
{
"sub": "string",
"iss": "string",
"aud": "string",
"org_id": "string",
"email": "string",
"email_verified": true,
"phone_number": "string",
"phone_number_verified": true,
"username": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}