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

FrankieOne Individual Documents API

Manage documents for individuals

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

Tagged areas include Individual Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.uat.frankie.one.

6 operations 3 paths 31 schemas 2 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.frankie.one
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

FrankieOne Individual Documents API declares 2 security schemes for authenticating requests. An API key is passed in the header as api_key (Api-Key). It accepts HTTP bearer tokens (JWT) (jwt). By default, every request must be authenticated.

Paths & Operations 6

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

Individual Documents 6

Manage documents for individuals

POST
/v2/individuals/{entityId}/documents
Create a new document for an individual.
createDocuments 7 params body → 201400401500502503
GET
/v2/individuals/{entityId}/documents
Get all documents for an entity
getDocuments 7 params → 200400401500502503
PATCH
/v2/individuals/{entityId}/documents/{documentId}
Update a single document by it's id.
updateDocument 8 params body → 200400401404500502503
GET
/v2/individuals/{entityId}/documents/{documentId}
Get a single document by it's id.
getDocument 8 params → 200400401404500502503
DELETE
/v2/individuals/{entityId}/documents/{documentId}
Delete a document
deleteDocument 7 params → 200400401500502503
DELETE
/v2/individuals/{entityId}/documents/{documentId}/attachments/{attachmentId}
Delete an attachment
deleteAttachments 8 params → 200400401500502503

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Document-Information (18 properties), Document-Attachment (13 properties), Date-Base (5 properties), Entity-Documents (4 properties). Each schema is shown below with its type and property counts.

Document-Supplementary-Data-National-Health-ID
object
Supplementary information relevant to a national health id.
Custom-Attributes
object
Document-Attachment-ID
string
When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. I…
Date
object
Data-URI-Base64
A Base64-encoded string or URI representing the data.
Document-Supplementary-Data-Passport
object
Supplementary information relevant to a national health id.
Document-Attachment-Type
string
General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, image…
individuals_entity_document_response
object
3 properties 1 required
Comment
object
2 properties
Document-Attachment-Retrieval-Status
string
The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provide…
Attribute
object
2 properties 2 required
Document-Supplementary-Data-Citizenship
object
Supplementary information relevant to a citizenship certificate.
Error-Base
object
3 properties
Issue
object
3 properties
Document-Supplementary-Data-Base
object
Supplementary data associated with a document.
1 property 1 required
Document-Supplementary-Data-National-ID
object
Supplementary information relevant to a national ID.
Entity-Documents
object
4 properties
Document-Type
string
Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERSLICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (…
Error
object
Date-Type
string
The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESOAMERICAN, PERSIAN, or OTHER.
Request-ID
string
The unique request identifier for the API call made.
Document-Supplementary-Data-Marriage-Certificate
object
Supplementary information relevant to a marriage certificate.
Document-Information
object
18 properties 2 required
Document-Supplementary-Data
object
Supplementary information relevant to a specific document or report type.
Document-Supplementary-Data-Birth-Certificate
object
Supplementary information relevant to a birth certificate.
Document-Class
string
The classification of the document, indicating how it should be used or interpreted.
Date-Base
object
5 properties
Document-Attachment-Side
string
Indicates whether the attachment is the front or back side of a document.
Document-ID
string
As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documen…
Document-Attachment
object
Document attachment details.
13 properties 1 required
Entity-ID
string
Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

frankieone-individual-documents-api-openapi.yml Raw ↑

Other APIs FrankieOne publishes across the network.

FrankieOne Audit API
FrankieOne HostedURL API
FrankieOne IDV API
FrankieOne Individual Entities API
FrankieOne Individual Entity Elements API
FrankieOne Individual Profiles API
FrankieOne Individual Results API
FrankieOne Individual Risks API
FrankieOne Individual Workflows API
FrankieOne Matchlists API
FrankieOne Monitoring API
FrankieOne Search API
Where this information came from

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