API V2 Route: Authentication

Last updated: August 28, 2026

Housing.Cloud V2 Public APIs utilizes scoped, short lived tokens for authentication and authorization. This endpoint must be utilized to generate the token.

General Details:

Endpoint	`/api/v2/auth`
Headers	`x-api-key:<string>` and `agent-id:<guid>`
HTTP Methods	`POST`
Request Body Format	`N/A`
Response Body Format	`JSON`

Example curl Request:

curl -X POST https://<your-institution>.housing.cloud/api/v2/auth \
  -H "x-api-key: <your-api-key>" \
  -H "agent-id: <your-agent-id>"

API Response:

Field Name	Data Type	Notes
token	string	JWT used for Authentication
expires	date string	ISO date string of expiration
scopes	string[]	Array of API Scopes granted to the JWT token
agentId	string	The Agent ID associated with the JWT token

Example Response:

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTk1MjA1NjcsImRhdGEiOnsic2NvcGVzIjpbIlBST0ZJTEVTX0dFVCIsIlRSQU5TQUNUSU9OU19HRVQiLCJQUk9GSUxFX0ZJRUxEU19HRVQiLCJQUk9GSUxFX0ZJRUxEX0FTU0lHTk1FTlRTX0dFVCIsIlBST0ZJTEVfRklFTERfQVNTSUdOTUVOVFNfUE9TVCJdLCJ0ZW5hbnRJZCI6MiwiYWdlbnRJZCI6ImFiNWY5NWIyLTMwM2EtNDAzYi04NWZkLWFiMWQwY2Q4MDkzYyJ9LCJpYXQiOjE3NTk1MTY5Njd9.j_DGYBHL7unsBfTtuffJr2jhwb766C07drTmDHzdiU4",
    "expires": "2025-03-12T19:42:47.395Z",
    "scopes": [
        "PROFILES_GET",
        "TRANSACTIONS_GET"
    ],
    "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c"
}