Monite Onboarding links API
The Onboarding links API from Monite — 2 operation(s) for onboarding links.
The Onboarding links API from Monite — 2 operation(s) for onboarding links.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/monite:monite-onboarding-links-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Monite Onboarding links API
contact:
name: Monite team
url: https://monite.com/about/
email: developers@monite.com
termsOfService: https://monite.com/terms
version: '1.0'
description: 'Operations tagged Onboarding links across 2 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dev.monite.com/v1
description: Development environment
- url: https://api.sandbox.monite.com/v1
description: Sandbox environment
- url: https://api.monite.com/v1
description: Production environment (Europe)
- url: https://us.api.monite.com/v1
description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
description: Oak POC environment
tags:
- name: Onboarding links
paths:
/onboarding_links:
post:
tags:
- Onboarding links
summary: Create Onboarding Link
operationId: post_onboarding_links
parameters:
- required: true
schema:
type: string
format: date
example: '2023-09-01'
name: x-monite-version
in: header
- description: The ID of the entity that owns the requested resource.
required: true
schema:
type: string
format: uuid
examples:
- 9d2b4c8f-2087-4738-ba91-7359683c49a4
name: x-monite-entity-id
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingLinkRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingLinkPublicResponse'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
servers:
- url: https://api.dev.monite.com/v1
description: Development environment
- url: https://api.sandbox.monite.com/v1
description: Sandbox environment
- url: https://api.monite.com/v1
description: Production environment (Europe)
- url: https://us.api.monite.com/v1
description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
description: Oak POC environment
/payment_onboarding_links:
post:
tags:
- Onboarding links
summary: Create an onboarding link
operationId: post_payment_onboarding_links
parameters:
- required: true
schema:
type: string
format: date
example: '2023-09-01'
name: x-monite-version
in: header
- description: The ID of the entity that owns the requested resource.
required: true
schema:
type: string
format: uuid
examples:
- 9d2b4c8f-2087-4738-ba91-7359683c49a4
name: x-monite-entity-id
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOnboardingLinkRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingLinkResponse'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
servers:
- url: https://api.dev.monite.com/v1
description: Development environment
- url: https://api.sandbox.monite.com/v1
description: Sandbox environment
- url: https://api.monite.com/v1
description: Production environment (Europe)
- url: https://us.api.monite.com/v1
description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
description: Oak POC environment
components:
schemas:
OnboardingLinkRequest:
properties:
expires_at:
type: string
format: date-time
refresh_url:
type: string
maxLength: 65536
minLength: 1
format: uri
return_url:
type: string
maxLength: 65536
minLength: 1
format: uri
additionalProperties: false
type: object
required:
- expires_at
- refresh_url
- return_url
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
msg:
type: string
type:
type: string
type: object
required:
- loc
- msg
- type
OnboardingLinkPublicResponse:
properties:
id:
type: string
format: uuid
entity_id:
type: string
format: uuid
expires_at:
type: string
format: date-time
refresh_url:
type: string
maxLength: 65536
minLength: 1
format: uri
return_url:
type: string
maxLength: 65536
minLength: 1
format: uri
url:
type: string
maxLength: 65536
minLength: 1
format: uri
additionalProperties: false
type: object
required:
- id
- entity_id
- expires_at
- refresh_url
- return_url
- url
RecipientType:
type: string
enum:
- entity
- counterpart
OnboardingLinkResponse:
properties:
id:
type: string
format: uuid
created_at:
type: string
format: date-time
expires_at:
type: string
format: date-time
recipient:
$ref: '#/components/schemas/Recipient'
refresh_url:
type: string
maxLength: 2083
minLength: 1
format: uri
return_url:
type: string
maxLength: 2083
minLength: 1
format: uri
url:
type: string
maxLength: 2083
minLength: 1
format: uri
additionalProperties: false
type: object
required:
- id
- created_at
- expires_at
- recipient
- refresh_url
- return_url
- url
ErrorSchemaResponse:
properties:
error:
$ref: '#/components/schemas/ErrorSchema'
type: object
required:
- error
ErrorSchema:
properties:
message:
type: string
type: object
required:
- message
CreateOnboardingLinkRequest:
properties:
recipient:
$ref: '#/components/schemas/Recipient'
refresh_url:
type: string
maxLength: 2083
minLength: 1
format: uri
return_url:
type: string
maxLength: 2083
minLength: 1
format: uri
additionalProperties: false
type: object
required:
- recipient
- refresh_url
- return_url
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
type: object
Recipient:
properties:
id:
type: string
format: uuid
type:
$ref: '#/components/schemas/RecipientType'
additionalProperties: false
type: object
required:
- id
- type
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
x-provenance:
method: harvested
publisher: Monite
source: https://docs.monite.com/_fern-files/docs.monite.com/9686796bddc2d6efcf41e03253cf6e254160c84d38eba4e3711f47d24e80402d/apis/v2024-05-25/openapi/2024-05-25.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)