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

Upward Financial consumers API

The consumers API from Upward Financial — 13 operation(s) for consumers.

Upward Financial consumers API is one of 17 APIs that Upward Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Consumers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against a single base URL, https://host.com.

19 operations 13 paths 23 schemas 1 DELETE11 GET5 POST2 PUT

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.upwardli.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Upward Financial consumers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 19

Across 13 paths, the API surfaces 19 operations — 1 DELETE, 11 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

consumers 19
GET
/v2/consumers/{consumer_id}/dispute/list/
List Consumer Disputes
list-consumer-disputes 5 params → 200
GET
/v2/consumers/{consumer_id}/accounts/
Get Consumer Bank Accounts
get-consumer-bank-accounts 5 params → 200
GET
/v2/consumers/{consumer_id}/payment-cards/
List Consumer Payment Cards
list-consumer-payment-cards 5 params → 200
GET
/v2/consumers/
List Consumers
list-consumers 4 params → 200
POST
/v2/consumers/
Create New Consumer
create-new-consumer 1 param body → 201
GET
/v2/consumers/{consumer_id}/
Retrieve Consumer
retrieve-consumer 2 params → 200
PUT
/v2/consumers/{consumer_id}/
Update Consumer
update-consumer 2 params body → 200
GET
/v2/consumers/pcid/{consumer_pc_id}/
Get Consumers By PCID
get-consumers-by-pcid 2 params → 200
GET
/v2/consumers/{consumer_id}/addresses/
List Consumer Addresses V 2
list-consumer-addresses-v-2 5 params → 200
POST
/v2/consumers/{consumer_id}/addresses/
Create Address V 2
create-address-v-2 2 params body → 201
GET
/v2/consumers/{consumer_id}/addresses/{address_id}/
Retrieve Address V 2
retrieve-address-v-2 3 params → 200
PUT
/v2/consumers/{consumer_id}/addresses/{address_id}/
Update Address V 2
update-address-v-2 3 params body → 200
DELETE
/v2/consumers/{consumer_id}/addresses/{address_id}/
Delete Address V 2
delete-address-v-2 3 params → 204
GET
/v2/consumers/{consumer_id}/invites/
List Consumer Invites
list-consumer-invites 5 params → 200
POST
/v2/consumers/{consumer_id}/invites/
Create Consumer Invites
create-consumer-invites 2 params body → 201
POST
/v2/consumers/{consumer_id}/dispute/
Create Consumer Dispute
create-consumer-dispute 2 params body → 201
POST
/v2/consumers/{consumer_id}/cancel-account/
Create Account Cancellation
create-account-cancellation 2 params body → 201
GET
/v2/consumers/{consumer_id}/payments/ach
List Consumer ACH Payments
list-consumer-ach-payments 5 params → 200
GET
/v2/consumers/{consumer_id}/payments/transfer
List Transfer Responses
list-transfer-responses 5 params → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are GetConsumer (19 properties), NewConsumer (13 properties), Address (11 properties), UpdateConsumer (11 properties). Each schema is shown below with its type and property counts.

UpdateConsumer
object
11 properties
NewConsumer
object
13 properties 2 required
BankAccountV2
object
10 properties 4 required
Consumers_getConsumerBankAccounts_Response_200
object
4 properties 2 required
GetUserInvitation
object
6 properties 2 required
Consumers_listConsumerDisputes_Response_200
object
4 properties 2 required
CreateUserInvitation
object
1 property 1 required
Consumers_listConsumerACHPayments_Response_200
object
4 properties 2 required
AddressCountry
string
ConsumerDispute
object
5 properties 1 required
Consumers_listTransferResponses_Response_200
object
4 properties 2 required
Consumers_ListConsumerAddressesV2_Response_200
object
4 properties 2 required
Consumers_listConsumers_Response_200
object
4 properties 2 required
Consumers_listConsumerInvites_Response_200
object
4 properties 2 required
AddressState
string
GetTransferResponse
object
6 properties 5 required
Consumers_DeleteAddressV2_Response_204
object
Empty response body
AccountCancellation
object
2 properties
Address
object
11 properties
AddressType
string
ConsumerDisputeStatus
string
Consumers_listConsumerPaymentCards_Response_200
object
4 properties 2 required
GetConsumer
object
19 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upward-financial-consumers-api-openapi.yml Raw ↑

Other APIs Upward Financial publishes across the network.

Upward Financial accounts API
Upward Financial auth API
Upward Financial billPayments API
Upward Financial billReporting API
Upward Financial billSwitch API
Upward Financial cbaas API
Upward Financial creditInsights API
Upward Financial onboarding API
Upward Financial partners API
Upward Financial paymentCards API
Upward Financial payments API
Upward Financial plaid API
Where this information came from

This is an independent, third-party profile of Upward Financial consumers 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.