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

Alloy Documents API

Uploaded identity, address, and supporting documents for entities.

Alloy Documents API is one of 19 APIs that Alloy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 8 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://sandbox.alloy.co/v1, https://alloy.co/v1, https://api.alloy.co/v1.

8 operations 5 paths 2 schemas 2 GET1 PATCH3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.alloy.co/v1
Authentication
HTTP Basic, OAuth 2.0, HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Alloy Documents API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It supports OAuth 2.0 (oauth2) using the clientCredentials flow. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (bearerAuth).

  • basic — HTTP basic authorization using a workflow token and secret
  • oauth2 — OAuth2 using a workflow token and secret to generate a bearer token
  • basicAuth — HTTP Basic Authentication with workflow or account-level API key as username and secret as password.
  • bearerAuth — OAuth 2.0 bearer token obtained via the OAuth endpoints.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 2 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 8

The document upload API is a two-step process. First, the metadata for the document is specified, and the API returns a file identifier so the file can be streamed directly to the…

GET
/entities/{entity_token}/documents
Get a List of All Documents for an Entity
1 param → 200
POST
/entities/{entity_token}/documents
Describe a Document Before Uploading
1 param body → 200
PUT
/entities/{entity_token}/documents/{document_token}
Submit a Document File for an Entity
2 params body → 200
GET
/entities/{entity_token}/documents/{document_token}
Get an Entity Document
getEntityDocument 2 params → 200
PATCH
/entities/{entity_token}/documents/{document_token}
Update an Entity Document
patchEntityDocument 2 params body → 200
POST
/documents
Upload a Document
postDocument body → 201
PUT
/documents/{document_token}
Replace a Document
putDocument 1 param body → 200
POST
/entities/{entity_token}/documents/{document_token}/notes
Add a Note to an Entity Document
postEntityDocumentNote 2 params body → 201

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Document (5 properties), Note (3 properties). Each schema is shown below with its type and property counts.

Note
object
3 properties
Document
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alloy-com-documents-api-openapi.yml Raw ↑

Other APIs Alloy publishes across the network.

Alloy Bank Accounts API
Alloy Batches API
Alloy Cases API
Alloy Custom Lists API
Alloy Entities API
Alloy Evaluations API
Alloy Events API
Alloy Groups API
Alloy Investigations API
Alloy Journeys API
Alloy Lists API
Alloy OAuth API
Where this information came from

This is an independent, third-party profile of Alloy Documents 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.