Skip to main content
GET
/
api
/
authorize
/
{auth_id}
/
status
Check authorization status
curl --request GET \
  --url https://submit.hackclub.com/api/authorize/{auth_id}/status \
  --header 'Authorization: Bearer <token>'
{
"auth_id": "8eaa8b02-1018-4075-aec0-7872e5db18aa",
"status": "pending",
"created_at": "2025-08-27T00:11:18.546Z",
"verified": false,
"identity_response": null
}
  • Checks the current status of an authorization request
  • Returns completion details if the user has completed the authorization flow
  • Requires Bearer token authentication with your program API key
  • Poll this endpoint every 2-3 seconds until status becomes completed

Authorizations

Authorization
string
header
required

Program API key obtained from the admin dashboard

Path Parameters

auth_id
string<uuid>
required

The authorization request ID

Response

Authorization status retrieved successfully

auth_id
string<uuid>
required
status
enum<string>
required

Current status of the authorization request

Available options:
pending,
completed,
expired,
failed
created_at
string<date-time>
required
idv_rec
string

Identity record ID (only present when status is 'completed')

completed_at
string<date-time>

When the authorization was completed (only present when status is 'completed')

verified
boolean

Whether the identity is verified and eligible. Present for all statuses to mirror /api/verify (true for completed, false otherwise).

identity_response
object

Filtered identity fields, mirroring /api/verify. Present when completed; null otherwise.

error
string

Present for non-success statuses (e.g., expired or failed).