GET /api/v1/me/natural-person/id-verification

Retrieve identity-verification images for the authenticated user.

Endpoint

GET /api/v1/me/natural-person/id-verification

Compatibility alias:

GET /api/v1/me/natural-person/id_verification

Authentication

This endpoint accepts either:

• an OAuth access token with the eprospera:person.id_verification.read scope, or
• an Agent Key (ak-) with the agent:person.id_verification.read scope

Standard API keys (sk-) are not supported on this endpoint.

Authorization: Bearer <access-token-or-agent-key>

Accepted Scopes

Provide the scope that matches the token type you are using:

• eprospera:person.id_verification.read
• agent:person.id_verification.read

Example Request

curl https://portal.eprospera.com/api/v1/me/natural-person/id-verification \
  -H "Authorization: Bearer <access-token-or-agent-key>"

Response

Success Response (200 OK)

Field	Type	Description
id	string | null	Verification-session ID.
type	string | null	Currently veriff when present.
date	string | null	Session creation timestamp.
status	string | null	Currently approved when present.
documents	object	Signed document URLs.
documents.documentFront	string | null	Signed URL for the front image.
documents.documentBack	string | null	Signed URL for the back image.
documents.face	string | null	Signed URL for the selfie image.

Example Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "veriff",
  "date": "2024-01-15T10:30:00.000Z",
  "status": "approved",
  "documents": {
    "documentFront": "https://...",
    "documentBack": "https://...",
    "face": "https://..."
  }
}

No approved verification on file

{
  "id": null,
  "type": null,
  "date": null,
  "status": null,
  "documents": {
    "documentFront": null,
    "documentBack": null,
    "face": null
  }
}

Notes

• The route returns the most recent approved identity-verification session.
• Signed URLs expire after 1 hour.
• Some ID types may not include documentBack.

Error Responses

401 Unauthorized

{
  "error": "missing_token"
}

{
  "error": "invalid_token"
}

403 Forbidden — Insufficient Scopes (OAuth token)

{
  "error": "missing_scopes: eprospera:person.id_verification.read"
}

403 Forbidden — Insufficient Scopes (Agent Key)

{
  "error": "Insufficient permissions"
}

500 Internal Server Error

{
  "error": "Internal server error"
}