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

HiPay ubo API

Manage your Ultimate Beneficial Ownerships (UBO)

HiPay ubo API is one of 20 APIs that HiPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths. It is described by OpenAPI 3.0.0, at version 1.6.1.

Requests are made against 2 base URLs: https://stage-api-gateway.hipay.com, https://api-gateway.hipay.com.

6 operations 4 paths 0 schemas 2 DELETE1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.6.1
Base URL
https://api-gateway.hipay.com
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

HiPay ubo API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as X-API-KEY (ApiKeyAuth).

Paths & Operations 6

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

ubo 6

Manage your Ultimate Beneficial Ownerships (UBO)

POST
/ubo.{_format}
Declare UBO
post_Ubo 22 params → 201400401403500
DELETE
/ubo/{id}.{_format}
Delete an UBO
delete_ubo 4 params → 200401403
POST
/ubo/legal-representative.{_format}
Declare UBO as legal representative
post_Ubo-legal-representative 13 params → 201400401403500
DELETE
/ubo/ubo-statement.{_format}
Delete a UBO statement
delete_ubo-statement 3 params → 200401403
GET
/ubo/ubo-statement.{_format}
Get a UBO statement. Get the list of all UBOs and documents for a user-space. If an UBO is refused, you should send us a new UBO with https://professional.hipay.com/api/ubo
get_ubo-statement 3 params → 200400401
POST
/ubo/ubo-statement.{_format}
Create a UBO statement
post_ubo-statement 4 params → 201400401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hipay-ubo-api-openapi.yml Raw ↑

Other APIs HiPay publishes across the network.

HiPay balance API
HiPay bank-info API
HiPay captcha-generation API
HiPay Connector API
HiPay constants API
HiPay identification API
HiPay invoice API
HiPay maintenance API
HiPay merchant-group API
HiPay Order API
HiPay payments API
HiPay Routing API