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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bridge

Bridge Customers API

The Customers API from Bridge — 9 operation(s) for customers.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bridge Customers API is one of 24 APIs that Bridge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 15 operations across 9 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://api.bridge.xyz/v0.

15 operations 9 paths 58 schemas 2 DELETE8 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://api.bridge.xyz/v0
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Bridge Customers API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Key (ApiKey). By default, every request must be authenticated.

Paths & Operations 15

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

Customers 15
GET
/customers
Get all customers
4 params → 200401500
POST
/customers
Create a customer
1 param body → 201401400500
GET
/customers/{customerID}
Get a single customer object
1 param → 200401404500
PUT
/customers/{customerID}
Update a single customer object
1 param body → 200401404500
DELETE
/customers/{customerID}
Delete a single customer object
1 param → 200401404500
GET
/customers/{customerID}/associated_persons
Get associated persons for a business customer
1 param → 200401404500
POST
/customers/{customerID}/associated_persons
Create a new associated person for a business customer
2 params body → 201401400404500
GET
/customers/{customerID}/associated_persons/{associatedPersonID}
Get a single associated person
2 params → 200401404500
PUT
/customers/{customerID}/associated_persons/{associatedPersonID}
Update a single associated person
2 params body → 200401400404500
DELETE
/customers/{customerID}/associated_persons/{associatedPersonID}
Delete a single associated person
2 params → 200401404500
GET
/customers/{customerID}/tos_acceptance_link
Retrieve a hosted URL for ToS acceptance for an existing customer
1 param → 200401500
GET
/customers/{customerID}/kyc_link
Retrieve a hosted KYC Link for an existing customer
3 params → 200401500
GET
/customers/{customerID}/transfers
Get all transfers
8 params → 200401500
GET
/customers/{customerID}/transfers/static_templates
Get all static templates for a customer
4 params → 200401404500
POST
/customers/tos_links
Request a hosted URL for ToS acceptance for new customer creation
1 param → 201401500

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are UpdateBusinessCustomerPayload (48 properties), UpdateIndividualCustomerPayload (31 properties), AssociatedPerson (28 properties), DepositInstructions (24 properties). Each schema is shown below with its type and property counts.

EndorsementType
string
The type of endorsement. Note: pixonramp (BRL deposits via PIX) and pixofframp (BRL withdrawals via PIX) can be requested individually for granular access. Req…
Currency
string
IndividualDocuments
array
Please click "ADD OBJECT" for more information.
UpdateIndividualCustomerPayload
object
31 properties
TransferReturnDetails
object
3 properties
ChargeBearer
string
Which party bears the SWIFT transaction charges. - our: the sender (ordering customer) pays all charges. - sha: charges are shared — the sender pays their own…
Error
object
3 properties 2 required
ExchangeDetails
object
Exchange information for a currency conversion.
5 properties
AssociatedPerson
object
28 properties 9 required
SwiftReference
string
A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by "\n"), each line with a…
SwiftCharges
string
Deprecated: this schema is the type of the deprecated swiftcharges field and will be removed in a future release. Prefer chargebearer, which is typed by Charge…
SpeiReference
string
A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric a-z, A-Z, 0-9, and space
TransferDestination
object
22 properties 2 required
SepaSwiftInclusivePaymentRail
string
SepaReference
string
A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must b…
BusinessDocuments
array
Please click "ADD OBJECT" for more information.
TrackingNumber
string
The primary tracking identifier for this fiat transaction. Format varies by payment rail (e.g., UETR for SEPA/FPS, clave de rastreo for SPEI, end-to-end ID for…
Uetr
string
Deprecated: use trackingnumber instead. The unique end-to-end transaction reference, for tracing purposes.
RejectionReason
object
Reason why the kycstatus was rejected
3 properties
CreateBusinessCustomerPayload
Imad
string
(Wire only) The IMAD of a wire transfer, if available
TransferState
string
DepositInstructions
object
24 properties 3 required
CustomerCapabilityState
string
State of the customer capability
CoBankTransferDocumentType
string
Colombian document type identifier. cc = Cédula de Ciudadanía, ce = Cédula de Extranjería, nit = NIT (tax ID), rut = RUT (worker registration), pa = Passport,…
EuroInclusiveCurrency
string
IdentifyingInformation
array
TransactionId
string
Deprecated: use trackingnumber instead. The unique transaction identifier for this payment.
PixReference
string
TransferResponse
object
18 properties 11 required
Id
string
A UUID that uniquely identifies a resource
EuroInclusiveFiatCurrency
string
Receipt
object
12 properties 4 required
TraceNumber
string
The trace number of an ACH transfer
PaymentRail
string
Omad
string
(Wire only) The OMAD of a wire transfer, if available
Clabe
string
The 18-digit CLABE (Clave Bancaria Estandarizada) of the sender who initiated this SPEI transaction
TransferSourcePaymentRail
string
CreateIndividualCustomerPayload
SepaSwiftInclusiveOfframpPaymentRail
string
WireMessage
string
A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 chara…
UpdateBusinessCustomerPayload
object
48 properties
EndorsementRequirementEnum
string
client_reference_id
string
A client-provided reference ID that uniquely identifies a resource in the client's system
PlaceOfBirthInput
object
Country (and optionally city) of birth. EEA / BBSA in-scope customers: supply when onboarding individuals or associated persons under the [EEA updated requirem…
2 properties
DepositId
string
A UUID that uniquely identifies a deposit
CustomerStatus
string
offboarded: represents a customer's account that was internally reviewed and closed due to suspicious activity. paused: represents a customer's account that is…
AchReference
string
A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.
Address2025WinterRefresh
object
6 properties 3 required
EndToEndId
string
The end-to-end ID of the FedNow transaction, assigned by the sending bank, and is not guaranteed to be unique across payments.
FasterPaymentsReference
string
Reference
A payment reference message for newer payment rails (e.g. Pix and Faster Payments).
Endorsement
object
5 properties 2 required
Customer
object
14 properties
PaymentScheme
string
AssociatedPersonResponse
object
12 properties 3 required
TransferSource
object
23 properties 2 required
ReturnInstructions
object
Optional instructions for where to send funds if the transfer is returned (e.g. refund). Only supported when the source payment rail is crypto. Memo is require…
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bridge-customers-api-openapi.yml Raw ↑

Other APIs Bridge publishes across the network.

Bridge API Keys API
AE Profile APIs.io
Bridge Associated Persons API
AE Profile APIs.io
Bridge Batch Settlements API
AE Profile APIs.io
Bridge Bridge Wallets API
AE Profile APIs.io
Bridge Cards API
AE Profile APIs.io
Bridge Crypto Return Policies API
AE Profile APIs.io
Bridge Developers API
AE Profile APIs.io
Bridge Exchange Rates API
AE Profile APIs.io
Bridge External Accounts API
AE Profile APIs.io
Bridge Fiat Payout Configuration API
AE Profile APIs.io
Bridge Funds Requests API
AE Profile APIs.io
Bridge KYC Links API
AE Profile APIs.io
#Customers
← Back to B APIs
API Details
ID
bridge:bridge-customers-api
Base URL
https://api.bridge.xyz/v0
Docs
https://apidocs.bridge.xyz/
Provider
Bridge
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bridge-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bridge-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Bridge Customers 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.