Skip to main content
GET
/
user
Get User
curl --request GET \
  --url https://api.example.com/user
{
  "contacts": [
    {
      "id": "<string>",
      "contact": "<string>"
    }
  ],
  "identityStatus": "HUMANOS",
  "organization": {
    "contacts": [
      "user@example.com",
      "+351912345678"
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "internalId": "internal-12345"
}

Documentation Index

Fetch the complete documentation index at: https://docs.humanos.tech/llms.txt

Use this file to discover all available pages before exploring further.

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

Verified contact value (email or phone)

Example:

"user@example.com"

​
id
string

Users VIA identifier

Example:

"did:web:humanos.tech:user:013a0628-fd20-4f73-a7d0-785e9f6e79c1"

​
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
SubjectIssuerEntity · object[]
required

List of verified contacts associated with the user

​
identityStatus
enum<string>
required

Identity status of the subject within the issuer

  • none: no identity verified
  • kyc: this user has an identity within your organization
  • humanos: this user has a humanos verified identity
Available options:
NONE,
KYC,
HUMANOS
Example:

"HUMANOS"

​
organization
object
required

Organization-collected contacts (no identity data — see backend reveal flow).

​
createdAt
string<date-time>
required

Date the subject was first registered

​
internalId
string

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

Example:

"internal-12345"