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

Flatfile subpackage_auth API

The subpackage_auth API from Flatfile — 2 operation(s) for subpackage_auth.

Flatfile subpackage_auth API is one of 32 APIs that Flatfile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.x.flatfile.com/v1.

2 operations 2 paths 12 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.x.flatfile.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Flatfile subpackage_auth API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

subpackage_auth 2
GET
/auth/publishable-key
Obtain the publishable key for a specific environment
get-publishable-key 3 params → 200400404
GET
/auth/sftp-credentials
Get SFTP credentials for Space
get-sftp-credentials 3 params → 200400404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are type_auth:ApiKey (10 properties), type_auth:SftpCredentials (4 properties), type_commons:Error (2 properties), type_auth:ApiKeyOperation (2 properties). Each schema is shown below with its type and property counts.

type_auth:ApiKeyOperation
object
2 properties 2 required
type_auth:SftpCredentials
object
Credentials being used to login to SFTP with host and port
4 properties 4 required
type_auth:PublishableKeyResponse
object
1 property 1 required
type_auth:RawKey
string
Raw Api Key
type_auth:ApiKeyId
string
Api Key ID
type_commons:AccountId
string
Account ID
type_commons:Errors
object
1 property 1 required
type_auth:ApiKeyType
string
type_commons:EnvironmentId
string
Environment ID
type_commons:Error
object
2 properties 1 required
type_auth:ApiKey
object
API Key used for authenticating against our APIs
10 properties 4 required
type_commons:SpaceId
string
Space ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-auth-api-openapi.yml Raw ↑

Other APIs Flatfile publishes across the network.

Flatfile subpackage_accounts API
Flatfile subpackage_actions API
Flatfile subpackage_agent-exports API
Flatfile subpackage_agents API
Flatfile subpackage_apps API
Flatfile subpackage_assistant API
Flatfile subpackage_canvas-areas API
Flatfile subpackage_commits API
Flatfile subpackage_data-clips API
Flatfile subpackage_data-retention-policies API
Flatfile subpackage_documents API
Flatfile subpackage_entitlements API
Where this information came from

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