e-Próspera API

Appearance

GET /api/oauth/userinfo ​

Read standard OIDC user claims for the authenticated user.

Endpoint ​

text
GET /api/oauth/userinfo

Authentication ​

Requires a valid bearer access token.

text
Authorization: Bearer <access-token>

Response Shape ​

The response always contains:

FieldTypeDescription
substringStable e-Próspera user ID.

Additional fields depend on scopes:

When profile is granted ​

FieldType
namestring | null
given_namestring | null
family_namestring | null
picturestring | null

When email is granted ​

FieldType
emailstring | null
email_verifiedboolean

Example Response ​

json
{
  "sub": "0b8f7c17-5f43-4f8a-9a43-0e1f2a3b4c5d",
  "name": "Maria Rodriguez",
  "given_name": "Maria",
  "family_name": "Rodriguez",
  "picture": "https://...",
  "email": "maria@example.com",
  "email_verified": false
}

Error Responses ​

401 Unauthorized ​

json
{
  "error": "missing_token"
}
json
{
  "error": "invalid_token"
}

404 Not Found ​

json
{
  "error": "user_not_found"
}

Notes ​

  • userinfo returns standard OIDC claims only.
  • Use the public /api/v1/me/* endpoints for Próspera-specific data such as residency, identity-verification images, and legal-entity records.