Highline Users API
The Users API from Highline — 4 operation(s) for users.
OpenAPI Specification
openapi: 3.1.0
info:
title: Highline Auth Users API
description: 'Highline is a payment solution enabling direct paycheck deductions
(pay-by-paycheck). This OpenAPI definition is generated best-effort
from public docs at https://docs.highline.co/.
'
version: 1.0.0
contact:
name: Highline
url: https://docs.highline.co/
servers:
- url: https://api.highline.co
description: Production
- url: https://api.sandbox.highline.co
description: Sandbox
security:
- bearerAuth: []
tags:
- name: Users
paths:
/users/{user-id}:
get:
tags:
- Users
summary: Get A User
parameters:
- $ref: '#/components/parameters/UserId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
/users/match:
post:
tags:
- Users
summary: Check User Eligibility
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
phone:
type: string
first_name:
type: string
last_name:
type: string
responses:
'200':
description: OK
/users/simulate-identity:
post:
tags:
- Users
summary: Simulate a new user identity (sandbox)
responses:
'200':
description: OK
/users/{user-id}/simulate-incoming-transfer:
post:
tags:
- Users
summary: Simulate Receiving Payroll Deposit (sandbox)
parameters:
- $ref: '#/components/parameters/UserId'
responses:
'200':
description: OK
components:
parameters:
UserId:
name: user-id
in: path
required: true
schema:
type: string
schemas:
User:
type: object
properties:
id:
type: string
email:
type: string
first_name:
type: string
last_name:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT