Platform
Caller identity
curl -X GET "https://external-api.paraform.com/api/external/v1/identity" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"principal": "agency",
"clientId": "string",
"agencyId": "string",
"name": "string",
"access": "ALL",
"scopes": [
"string"
],
"environment": "string"
}
Required scopes:
Rate limit:
identity:readRate limit:
default tier, 120 requests per minute per keyprincipal is agency for an agency integration key (it acts as the agency’s API service principal) or recruiter for a recruiter’s personal key (it acts as that recruiter). Read principal first: the remaining identity fields differ between the two.
scopes is the key’s EFFECTIVE scope set: everything its access tier grants plus any scopes granted explicitly, so it is the list scope checks evaluate. An ALL key reports the full scope vocabulary, not an empty list. A recruiter’s personal key only ever reports recruiter scopes: its access tier adds no agency scope. environment is the key’s environment (live when none is recorded). email is null when the recruiter has no email on file.
Response
The response takes one of 2 shapes.Hide principal: 'agency'
Hide principal: 'agency'
Hide principal: 'recruiter'
Hide principal: 'recruiter'
curl -X GET "https://external-api.paraform.com/api/external/v1/identity" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"principal": "agency",
"clientId": "string",
"agencyId": "string",
"name": "string",
"access": "ALL",
"scopes": [
"string"
],
"environment": "string"
}
⌘I
curl -X GET "https://external-api.paraform.com/api/external/v1/identity" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"principal": "agency",
"clientId": "string",
"agencyId": "string",
"name": "string",
"access": "ALL",
"scopes": [
"string"
],
"environment": "string"
}