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

Koin Onboarding Services API

Onboarding Service

Koin Onboarding Services API is one of 16 APIs that Koin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api-sandbox.koin.com.br.

2 operations 2 paths 15 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api-sandbox.koin.com.br
Resource Areas
1

Paths & Operations 2

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

Onboarding Services 2

Onboarding Service

POST
/v1/onboarding
Send Data
evaluationUsingPOST body → 200400401500
GET
/v1/onboarding/{id}
Get Status
onboardingStatusUsingGET 2 params → 200400401404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PersonData (10 properties), CompanyData (8 properties), TransferData (8 properties), StandardApiResponse (6 properties). Each schema is shown below with its type and property counts.

CompanyData
object
8 properties 8 required
Address
object
3 properties 3 required
Contact
object
3 properties 3 required
OnboardingRequest
object
4 properties 4 required
BadResponse
object
2 properties
PaymentAccount
object
3 properties 1 required
Transaction
object
2 properties 1 required
Credentials
object
3 properties 1 required
TransferData
object
8 properties 8 required
PersonData
object
10 properties 10 required
StandardApiResponse
object
6 properties 3 required
PricingDetail
object
3 properties 3 required
Payment
object
5 properties 3 required
Store
object
5 properties 4 required
PricingData
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koin-onboarding-services-api-openapi.yml Raw ↑

Other APIs Koin publishes across the network.

Koin Access API
Koin Account Take Over Services API
Koin Availability Services API
Koin Communication Services API
Koin Ecommerce API
Koin Notification Services Sales API
Koin Payment Service Provider API
Koin Payment Services API
Koin PaymentRequest API
Koin Payout Services API
Koin Recipient Services Account API
Koin Refund Services API