Skip to main content
GET
/
user
Get User
curl --request GET \
  --url https://api.example.com/user
{
  "contacts": [
    {
      "contact": "user@example.com",
      "verified": true,
      "did": "did:via:humanos:user-abc123"
    }
  ],
  "identity": {
    "fullName": "John Doe",
    "birth": "1990-01-01",
    "docId": "1234567890",
    "countryAlpha3": "PRT",
    "fullDocId": "12345678901234",
    "gender": "M",
    "expiresAt": "2025-01-01",
    "issueDate": "2010-01-01",
    "taxNumber": "123456789",
    "healthNumber": "987654321",
    "socialSecurityNumber": "111222333",
    "photo": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
    "height": "175",
    "documentType": "passport",
    "documentDiscriminator": "ZWX1",
    "placeOfBirth": "Lisbon",
    "mrzText": "P<PRTDOE<<JOHN<<<<<<<<<<<<<<<<<<<<<<<<<",
    "extra": "{\"notes\": \"Additional information\"}"
  },
  "internalId": "internal-12345"
}

Headers

​
API-Version
string

Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today's date.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-03"

Query Parameters

​
contact
string

Contact value (email or phone)

Example:

"user@example.com"

​
did
string

Public Decentralized Identifier (DID) of the user

Example:

"did:via:humanos:user-abc123"

​
internalId
string

Identifier to help you identify the user in your own system. We recommend using a unique value.

Example:

"internal-12345"

Response

Contact information, identity data (if available), and the internal ID

​
contacts
SubjectEntity · object[]
required

List of contacts associated with the user

​
identity
object

Identity information (KYC data) for the user, if available

​
internalId
string

Identifier to help you identify the user in your own system. We recommend using a unique value.

Example:

"internal-12345"