API reference
List open identity reviews
GET
When a forwarded resume might belong to a candidate Probb already has, it asks instead of guessing. This lists the open reviews, oldest first, up to 50, with the candidates each one offers; resolve some to see the rest. Filter by jobId. Decide with POST /v1/identity-reviews/{id}/resolve. fileName is supplied by the sender.
Required scope: inbox:read (inbox:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
inbox_unavailable,service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>jobId?stringOnly reviews for files forwarded for this job.
Length
1 <= length <= 200Success.
application/json- response
object*stringdata*array<>The identity reviews on this page.
hasMore*booleanWhether another page follows.
nextCursor*|Pass as cursor to fetch the next page, or null at the end.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/identity-reviews" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "list", "data": [ { "object": "identity_review", "id": "string", "status": "open", "createdAt": "2019-08-24T14:15:22Z", "ingestionItemId": "string", "inboundEmailId": "string", "fileName": "string", "candidateEmail": "string", "jobId": "string", "jobTitle": "string", "forwardedBy": { "id": "string", "name": "string" }, "candidates": [ { "id": "string", "name": "string", "email": "string", "linkedinUrl": "string", "currentRole": "string", "createdAt": "2019-08-24T14:15:22Z", "reportCount": -9007199254740991, "reasons": [ "string" ], "similarity": 0 } ], "resolvedCandidateId": "string", "resolvedAt": "2019-08-24T14:15:22Z" } ], "hasMore": true, "nextCursor": "string"}