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

Simplifi/Simplifipay User API

The User API from Simplifi/Simplifipay — 4 operation(s) for user.

Simplifi/Simplifipay User API is one of 9 APIs that Simplifi/Simplifipay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{env}-lb.simplifipay.com.

7 operations 4 paths 8 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://uat-lb.simplifipay.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — JWT access token from POST /v1/auth/login/{companyName}, sent as Authorization: Bearer .

Paths & Operations 7

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

User 7
GET
/v1/user
List all Users
listAllUsers 4 params → 200400401
POST
/v1/user
Create a User
createAUser 2 params body → 200400401
POST
/v1/document
Upload Document
uploadDocument 2 params body → 200400401
GET
/v1/user/{uuid}
Retrieve a User
retrieveAUser 3 params → 200400401
PUT
/v1/user/{uuid}
Update a User
updateAUser 3 params body → 200400401
DELETE
/v1/user/{uuid}
Delete a User
deleteAUser 3 params → 200400401
POST
/v1/user/{uuid}/address/{type}
Add update address of user
addUpdateAddressOfUser 4 params body → 200400401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are UserModel (13 properties), UserRequestModel (8 properties), AddressModel (7 properties), AddressRequestModel (6 properties). Each schema is shown below with its type and property counts.

ContactModel
object
2 properties 2 required
UserModel
object
13 properties 10 required
ErrorModel
object
2 properties
AddressModel
object
7 properties 2 required
UserRequestModel
object
8 properties 7 required
AddressRequestModel
object
6 properties 4 required
UserDetailModel
object
4 properties 3 required
DocumentModel
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

simplifi-simplifipay-user-api-openapi.yml Raw ↑

Other APIs Simplifi/Simplifipay publishes across the network.

Simplifi/Simplifipay Auth API
Simplifi/Simplifipay Card API
Simplifi/Simplifipay Card Program API
Simplifi/Simplifipay Document API
Simplifi/Simplifipay Fee API
Simplifi/Simplifipay Funding Source API
Simplifi/Simplifipay Transaction API
Simplifi/Simplifipay Webhook API
Where this information came from

This is an independent, third-party profile of Simplifi/Simplifipay User 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.