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

Upvest User Identifiers API

Manage external identifiers associated with users.

Upvest User Identifiers API is one of 35 APIs that Upvest publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 10 JSON Schema definitions.

Tagged areas include User Identifiers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 10 JSON Schemas.

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

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

4 operations 2 paths 4 schemas 2 GET1 PATCH1 POST

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.upvest.co
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Upvest User Identifiers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • oauth2ClientCredentials — OAuth 2.0 client credentials flow. Obtain an access token by providing your client ID and client secret.

Paths & Operations 4

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

User Identifiers 4

Manage external identifiers associated with users.

GET
/users/{user_id}/identifiers
Upvest List user identifiers
listUserIdentifiers 1 param → 200401404
POST
/users/{user_id}/identifiers
Upvest Create a user identifier
createUserIdentifier 1 param body → 201400401
GET
/users/{user_id}/identifiers/{identifier_id}
Upvest Retrieve a user identifier
retrieveUserIdentifier 2 params → 200401404
PATCH
/users/{user_id}/identifiers/{identifier_id}
Upvest Update a user identifier
updateUserIdentifier 2 params body → 200400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), UserIdentifier (4 properties), UserIdentifierCreate (2 properties), UserIdentifierUpdate (1 property). Each schema is shown below with its type and property counts.

UserIdentifierUpdate
object
Request body for updating a user identifier.
1 property
UserIdentifierCreate
object
Request body for creating a user identifier.
2 properties 2 required
UserIdentifier
object
An external identifier associated with a user.
4 properties
Error
object
An API error response.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upvest-user-identifiers-api-openapi.yml Raw ↑

Other APIs Upvest publishes across the network.

Upvest Account Transfers API
Upvest Accounts API
Upvest Authentication API
Upvest Cash Balances API
Upvest Corporate Actions API
Upvest Direct Debits API
Upvest Executions API
Upvest Fee Configurations API
Upvest Fees API
Upvest Files API
Upvest Instrument Prices API
Upvest Instruments API
Where this information came from

This is an independent, third-party profile of Upvest User Identifiers 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.