This article covers the three Reference Check endpoints: retrieving reference checks (with attached files) for a candidate, uploading a file to an existing reference check, and deleting a previously uploaded reference check file.
Retrieving Reference Checks with Files
GET
Retrieves a list of reference checks for a candidate, including any files attached to each reference check. Reference checks are returned as part of the candidate record by requesting the referenceCheck field.
https://api.recman.io/v2/get/index.php?scope=candidate&key={{api_key}}&page=1&candidateId={{candidateId}}&fields=referenceCheckThe candidateFileId returned for each file can be used to download the file via the candidate files download endpoint.
| Parameter | Required | Description |
|---|---|---|
| key | Required | Your API key |
| scope | Required | Must be set to candidate |
| page | Required | Page number |
| candidateId | Required | The ID of the candidate whose reference checks should be retrieved |
| fields | Required | Must include referenceCheck to return reference check data. |
Each returned reference check includes the following fields:
| Field | Type | Description |
|---|---|---|
| referenceCheckId | integer | The ID of the reference check |
| notes | string | Free text notes for the reference check |
| status | integer | 0 = Not approved, 1 = Approved |
| created | date-time | Creation date, format "Y-m-d H:i:s" |
| updated | date-time | Last updated date, format "Y-m-d H:i:s" |
| files | array of object | Files attached to the reference check; see the table below. |
Each object in the files array contains:
| Field | Type | Description |
|---|---|---|
| referenceCheckFileId | integer | The ID of the file on the reference check |
| name | string | File name with extension |
| created | date-time | Creation date, format "Y-m-d H:i:s" |
| candidateFileId | integer | The candidate file ID, used to download the file via the candidate files download endpoint. |
Uploading a Reference Check File
POST
Uploads a file and attaches it to an existing reference check on a candidate. The response includes both a referenceCheckFileId and a fileId.
https://api.recman.io/v2/post/Operation: insert, scope: candidate.
| Field | Type | Description |
|---|---|---|
| candidateId | integer | Required. The ID of the candidate the reference check belongs to. |
| file | object | Required. See sub-fields below. |
The file object requires the following sub-fields:
| Sub-field | Type | Description |
|---|---|---|
| name | string | Name of the file |
| ext | string | File extension, e.g., "jpeg" |
| created | date-time | Format "Y-m-d H:i:s" |
| referenceCheckId | integer | Required. The ID of the reference check to attach the file to |
| base64 | string | Base64-encoded file content |
Note
To find a candidate's existing reference check IDs, use the Get Candidate request with thereferenceCheck field included.
Deleting a Reference Check File
POST
Deletes a previously uploaded reference check file.
https://api.recman.io/v2/post/Operation: delete, scope: candidateReferenceCheckFile.
| Field | Type | Required | Description |
|---|---|---|---|
| candidateId | integer | Required | The ID of the candidate |
| referenceCheckId | integer | Required | The ID of the reference check the file belongs to |
| referenceCheckFileId | integer | Required | The ID of the file to delete |
Note
To obtain information about a candidate's reference checks and their attached files, use the Get Candidate request with the referenceCheck field included.