curl --request POST \
--url https://hiimpria.ai/api/test/url \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://domain.edu/course/12345"
}
'{
"ltiassigned": true,
"status": "active",
"name": "Acme University",
"ainame": "Hugo",
"picture": "https://storage.example.com/logo.png",
"publicId": "bc6efd03-9d01-43e7-bd49-c4af1c54ae3a"
}Testing
Retrieves an institution and validates user access for a specific context
Use this method to determine if your originating URL or institution ID is associated with an institution, and optionally validate user access status. The properties returned can be used for branding your AI application.
Rate Limiting: 30 requests per minute per IP address.
Lookup Priority:
- First attempts to find institution by matching
urlagainst registered LTI context IDs - If not found, falls back to direct lookup by
institutionid(publicId)
User Validation (optional):
When email or userid is provided, the endpoint also validates:
- User account status (must be ‘active’)
- User-Institution membership status (must be ‘active’)
Status Values:
active: Institution/user is active and accessibleinactive: Institution or user account is inactivepending: User membership is pending approvalsuspended: User membership is temporarily suspendedinvalid: No institution found matching the provided criteria
POST
/
api
/
test
/
url
curl --request POST \
--url https://hiimpria.ai/api/test/url \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://domain.edu/course/12345"
}
'{
"ltiassigned": true,
"status": "active",
"name": "Acme University",
"ainame": "Hugo",
"picture": "https://storage.example.com/logo.png",
"publicId": "bc6efd03-9d01-43e7-bd49-c4af1c54ae3a"
}Body
application/json
Response
URL test completed successfully
Was this page helpful?