User Identity Repository - API Contract

GET /api/v1/user-identities/api/v1/user-identities

List user identity records

Public

Response Example

{
  "data": [
    {
      "user_id": "usr_7f3a1c9d",
      "nin": "15076500565",
      "bankid_verified": true,
      "nin_stored_at": "2026-03-26T10:13:00Z",
      "bankid_verified_at": "2026-03-26T10:13:10Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

GET /api/v1/user-identities/api/v1/user-identities/:user_id

Get identity record for a specific user

Public

Response Example

{
  "user_id": "usr_7f3a1c9d",
  "nin": "15076500565",
  "bankid_verified": true,
  "nin_stored_at": "2026-03-26T10:13:00Z",
  "bankid_verified_at": "2026-03-26T10:13:10Z"
}

POST /api/v1/user-identities/api/v1/user-identities

Save personnummer for a user

Public

Request Example

{
  "user_id": "usr_7f3a1c9d",
  "nin": "15076500565"
}

Response Example

{
  "user_id": "usr_7f3a1c9d",
  "nin": "15076500565",
  "bankid_verified": false,
  "nin_stored_at": "2026-03-26T10:13:00Z"
}

PUT /api/v1/user-identities/api/v1/user-identities/:user_id

Update BankID verification status or NIN for a user

Public

Request Example

{
  "bankid_verified": true
}

Response Example

{
  "user_id": "usr_7f3a1c9d",
  "nin": "15076500565",
  "bankid_verified": true,
  "bankid_verified_at": "2026-03-26T10:13:10Z",
  "updated_at": "2026-03-26T10:13:10Z"
}

DELETE /api/v1/user-identities/api/v1/user-identities/:user_id

Delete identity record for a user (GDPR erasure)

Public

Response Example

{
  "user_id": "usr_7f3a1c9d",
  "deleted": true,
  "deleted_at": "2026-03-26T12:00:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}