How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZippedScript Reference Checks API

The reference_checks API from ZippedScript — 7 operation(s) for reference_checks.

ZippedScript Reference Checks API is one of 7 APIs that ZippedScript publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Reference Checks. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 10 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, http://app.zippedscript.com/api/v1.

10 operations 7 paths 7 schemas 1 DELETE4 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
http://app.zippedscript.com/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

ZippedScript Reference Checks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Enter the full header value, including the prefix: Token for an API key from GET /user/api-key, or Bearer for a JWT from POST /user/login. A bare key without t…

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

reference_checks 10
GET
/reference_checks/
List Reference Check Records
reference_checks_list 8 params → 200
POST
/reference_checks/
Create Reference Check Record
reference_checks_create body → 201
GET
/reference_checks/check_request_id/{request_id}
Check Request ID
reference_checks_check_request_id_read 1 param → 200
GET
/reference_checks/token/{token}
Retrieve Reference Checks by Token
reference_checks_token_read 2 params → 200404
GET
/reference_checks/{reference_check_id}
Retrieve reference check details
reference_checks_read 2 params → 200404
PUT
/reference_checks/{reference_check_id}
Update reference check details
reference_checks_update 2 params body → 200400403404
DELETE
/reference_checks/{reference_check_id}
Delete reference check record
reference_checks_delete 2 params → 204404
POST
/reference_checks/{reference_check_id}/cancel
Cancel reference check request
reference_checks_cancel_create 2 params → 200400404
POST
/reference_checks/{reference_check_id}/consent
Upload end-user consent file(s)
reference_checks_consent_create 2 params body → 201400404
POST
/reference_checks/{reference_check_id}/verify
Submit reference check verification
reference_checks_verify_create 2 params body → 200400404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ReadReferenceCheck (18 properties), UpdateReferenceCheck (13 properties), CreateReferenceCheck (7 properties), CreateReferenceCheckVerification (6 properties). Each schema is shown below with its type and property counts.

Candidate
object
3 properties 1 required
UpdateReferenceCheck
object
13 properties
CreateReferenceCheckVerification
object
6 properties 1 required
PaginatedReadReferenceCheckSerializer
object
4 properties 4 required
ReferenceStatus
object
2 properties 1 required
CreateReferenceCheck
object
7 properties 4 required
ReadReferenceCheck
object
A list of the returned records
18 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zippedscript-reference-checks-api-openapi.yml Raw ↑

Other APIs ZippedScript publishes across the network.

ZippedScript Authentication API
ZippedScript Direct API
ZippedScript Employment API
ZippedScript Institution API
ZippedScript User API
ZippedScript Verification API
Where this information came from

This is an independent, third-party profile of ZippedScript Reference Checks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.