ZippedScript · Schema
UpdateReferenceCheck
CompanyEducationVerificationSoftware-as-a-ServiceBackground Checks
Properties
| Name | Type | Description |
|---|---|---|
| candidate | string | |
| request_id | string | |
| reference_name | string | |
| reference_email | string | The email of the reference to send the check request to. |
| relationship | stringnull | Relationship to the candidate |
| additional_details | objectnull | |
| end_user_consent_files | objectnull | |
| lang | string | |
| initial_email_sent | boolean | |
| cadence_emails_sent | integer | |
| last_cadence_email_sent | stringnull | |
| company | integer | |
| initiator | integernull | The user who created the reference check request |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/zippedscript/json-schema/zippedscript-update-reference-check-schema.json",
"title": "UpdateReferenceCheck",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/zippedscript-reference-checks-api-openapi.yml#/components/schemas/UpdateReferenceCheck",
"type": "object",
"properties": {
"candidate": {
"title": "Candidate",
"type": "string"
},
"request_id": {
"title": "Request id",
"type": "string",
"maxLength": 256,
"minLength": 1
},
"reference_name": {
"title": "Reference name",
"type": "string",
"maxLength": 255,
"minLength": 1
},
"reference_email": {
"title": "Reference email",
"description": "The email of the reference to send the check request to.",
"type": "string",
"format": "email",
"maxLength": 254,
"minLength": 1
},
"relationship": {
"title": "Relationship",
"description": "Relationship to the candidate",
"type": [
"string",
"null"
],
"maxLength": 255
},
"additional_details": {
"title": "Additional details",
"type": [
"object",
"null"
]
},
"end_user_consent_files": {
"title": "End user consent files",
"type": [
"object",
"null"
]
},
"lang": {
"title": "Lang",
"type": "string",
"maxLength": 10
},
"initial_email_sent": {
"title": "Initial email sent",
"type": "boolean"
},
"cadence_emails_sent": {
"title": "Cadence emails sent",
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"last_cadence_email_sent": {
"title": "Last cadence email sent",
"type": [
"string",
"null"
],
"format": "date-time"
},
"company": {
"title": "Company",
"type": "integer"
},
"initiator": {
"title": "Initiator",
"description": "The user who created the reference check request",
"type": [
"integer",
"null"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/zippedscript-update-reference-check"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.