Users API

REST endpoints for querying and managing workforce individuals.

Retrieve a User

GET/v1/users/:id

Retrieves the public profile and any consented verifiable credentials for a specific user. You must have an active consent grant to view protected claims.

Path Parameters

ParameterTypeDescription
idstringThe user's unique DID or internal People Index ID.

Response Example

200 OK Response
{
  "id": "usr_29dn39dmk2",
  "did": "did:web:peopleindex.ai:user:892",
  "status": "VERIFIED",
  "profile": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "credentials": [
    {
      "id": "http://peopleindex.ai/credentials/3732",
      "type": "EmploymentCredential",
      "issuer": "did:web:acmecorp.com"
    }
  ]
}