Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Highline Users API

The Users API from Highline — 4 operation(s) for users.

Highline Users API is one of 10 APIs that Highline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.highline.co, https://api.sandbox.highline.co.

4 operations 4 paths 1 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.highline.co
https://api.sandbox.highline.co
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Highline Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Users 4
GET
/users/{user-id}
Get A User
1 param → 200
POST
/users/match
Check User Eligibility
body → 200
POST
/users/simulate-identity
Simulate a new user identity (sandbox)
→ 200
POST
/users/{user-id}/simulate-incoming-transfer
Simulate Receiving Payroll Deposit (sandbox)
1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is User (4 properties). Each schema is shown below with its type and property counts.

User
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highline-fi-users-api-openapi.yml Raw ↑

Other APIs Highline publishes across the network.

Highline Pay by Paycheck API
Highline Auth API
Highline Companies API
Highline Connections API
Highline Employments API
Highline Payment Requests API
Highline Payments API
Highline Products API
Highline Settlements API