Businesses

Businesses are corperate entities within the OnRamp ecosystem. A business can have multiple users, but in itself can also be verified using several services. Use these endpoints to create businesses, retreive them or delete them.

The business model

The business model contains all the information about the Business in OnRamp.

Properties

Name
id
Type
string|uuid
Description
Unique identifier of the business.
Name
name
Type
string
Description
Name of the business.
Name
address
Type
string
Description
Full address of the business.
Name
street
Type
string
Description
Streetname of the business.
Name
housenumber
Type
string
Description
Housenumber of the business.
Name
addition
Type
string|null
Description
Optional housenumber addition of the business.
Name
postalcode
Type
string
Description
Postal code of the business.
Name
city
Type
string
Description
City of the business.
Name
country_id
Type
integer
Description
Identifier of the country associated with the business.
Name
iban_number
Type
string
Description
IBAN number associated with the business.
Name
coc_number
Type
string
Description
Chamber of Commerce number of the business.
Name
vat_number
Type
string
Description
VAT number of the business.
Name
is_active
Type
boolean
Description
Indicates if the business is active.
Name
inactive_at
Type
datetime
Description
Timestamp of when the business was deactivated.
Name
created_at
Type
datetime
Description
Timestamp of when the business was created.
Name
updated_at
Type
datetime
Description
Timestamp of the last update to the business.

Optional properties

Name
coc_check
Type
array
Description
Chamber of Commerce data pulled from the provider.
Name
iban_check
Type
array
Description
IBAN information pulled from the provider.
Name
vat_check
Type
array
Description
VAT information pulled from the provider.

POSTapi/v1/businesses/create

Create a business

Use this endpoint to create a business in your OnRamp environment.

Required attributes

Name
name
Type
string|max:255
Description
name of the business, required.
Name
country_code
Type
string|size:3
Description
Country code of the business, required. Must be ISO3 and an EU country.
Name
coc_number
Type
integer|digits_between:6,20
Description
Chamber of Commerce number of the business, required.
Name
vat_number
Type
string|null
Description
VAT number of the business, optional.
Name
iban_number
Type
string|null
Description
IBAN number associated with the business, optional.
Name
checks
Type
array
Description
List of checks queued for the business, required.
Name
checks.coc
Type
boolean
Description
Indicates if the Chamber of Commerce check must be queued, required. If enabled, do enter a COC number for Netherlands (NLD).
Name
checks.vat
Type
boolean
Description
Indicates if the VAT check must be queued, required. If enabled, do enter a VAT number.
Name
checks.iban
Type
boolean
Description
Indicates if the IBAN check must be queued, required. If enabled, do enter a IBAN number for Netherlands (NLD).

Request

POST

api/v1/businesses/create

curl -X POST https://app.onramp.nl/api/v1/businesses/create \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Company BV",
    "country_code": "NLD",
    "coc_number": "123456789",
    "vat_number": "NL1234567890",
    "iban_number": "NL91ABNA0123456789",
    "checks": {
      "coc": true,
      "vat": true,
      "iban": true
    }
  }'

Response

{
    "id": "11526e0e-e33f-4aa1-9d0b-ab2f3e8cd268",
    "name": "Company BV",
    "coc_number": "91234567",
    "vat_number": "NL1234567890",
    "iban_number": "NL91ABNA0123456789",
    "country_id": 148,
    "updated_at": "2025-05-01T09:21:23.000000Z",
    "created_at": "2025-05-01T09:21:23.000000Z",
    "messages": [
        "COC Check has been queued",
        "VAT Check has been queued",
        "IBAN Check has been queued"
    ]
}

POSTapi/v1/businesses/{id}/check

Create a business check request

You can also create a check request for an existing business, this can be done by using its UUID.

Request

POST

api/v1/businesses/{id}/check

curl -X POST https://app.onramp.nl/api/v1/businesses/{id}/check \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "type": [
        "iban",
        "coc",
        "vat",
    ]
  }'

Response

{
    "messages": [
        "IBAN Check has been queued",
        "COC Check has been queued",
        "VAT Check has been queued",
    ]
}

GETapi/v1/businesses

Get a list of all businesses

Get a paginated (cursor) list of businesses that are in your OnRamp environment.

Request

GET

api/v1/businesses

curl -G https://app.onramp.nl/api/v1/businesses \
    -H "Authorization: Bearer {api_key}" \
    -H "Accept: application/json" \

Response

{
    "data": [
        {
            "id": "351442b4-ba39-40d6-8ccf-3b0b96ce1a8a",
            "name": "Company BV",
            "coc_number": "90006527",
            "city": null,
            "is_active": 1,
            "inactive_at": null,
            "created_at": "2025-04-30T07:29:34.000000Z",
            "updated_at": "2025-04-30T07:29:34.000000Z"
        },
        {
            "id": "5aac72c5-47dc-4631-98b4-60a03342dfb4",
            "name": "Company BV",
            "coc_number": "90006127",
            "city": null,
            "is_active": 1,
            "inactive_at": null,
            "created_at": "2025-04-30T07:30:08.000000Z",
            "updated_at": "2025-04-30T07:30:08.000000Z"
        },
        .....
        .....
        .....
    ],
    "path": "https://app.onramp.nl/api/v1/businesses",
    "per_page": 20,
     "next_cursor": "eyJjdXN0b21lcnNfOWU5NDQ1NDYtMjZkNC00MDIzLWE1NGItZTg3MzFmOTY3ZGJmLmlkIjoiMjZmNzc2OGEtMTczZi00ODk4LWJjNzUtYmZkZTYyOWM1Y2U2IiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
    "next_page_url": "https://app.onramp.nl/api/v1/businesses?cursor=eyJjdXN0b21lcnNfOWU5NDQ1NDYtMjZkNC00MDIzLWE1NGItZTg3MzFmOTY3ZGJmLmlkIjoiMjZmNzc2OGEtMTczZi00ODk4LWJjNzUtYmZkZTYyOWM1Y2U2IiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
    "prev_cursor": null,
    "prev_page_url": null
}

GETapi/v1/businesses/{id}

Get a business by UUID

You can also get a business by UUID, to get more information regarding this business. This endpoint can also be used to retreive the latest check data.

Request

GET

api/v1/businesses

curl -G https://app.onramp.nl/api/v1/businesses/{id} \
    -H "Authorization: Bearer {api_key}" \
    -H "Accept: application/json" \

Response

{
    "id": "c1d764d6-4525-4b26-9993-60bfceb5d41e",
    "name": "Bedrijfsnaam",
    "address": "Straatnaam 1, 1234AB Stad",
    "street": "Straatnaam",
    "housenumber": "1",
    "addition": null,
    "postalcode": "1234AB",
    "city": "Stad",
    "country_id": 148,
    "iban_number": "NL91ABNA0123456789",
    "coc_number": "123456789",
    "vat_number": "NL1234567890",
    "is_active": 1,
    "inactive_at": null,
    "created_at": "2025-05-02T07:47:20.000000Z",
    "updated_at": "2025-06-05T09:01:57.000000Z",
    "coc_check": {
        "type": "coc",
        "data": {
            "truncated": true,
        },
        "validated": true,
        "created_at": "2025-05-02T07:47:33.000000Z",
        "updated_at": "2025-05-02T07:47:33.000000Z"
    },
    "iban_check": {
        "type": "iban",
        "data": {
            "truncated": true,
        },
        "validated": true,
        "created_at": "2025-06-05T09:01:54.000000Z",
        "updated_at": "2025-06-05T09:01:54.000000Z"
    },
    "vat_check": {
        "type": "vat",
        "data": {
            "truncated": true,
        },
        "validated": true,
        "created_at": "2025-05-02T07:55:24.000000Z",
        "updated_at": "2025-05-02T07:55:24.000000Z"
    }
}

DELETEapi/v1/businesses/

Delete a business

Request

DELETE

api/v1/businesses/{id}/delete

curl -G https://app.onramp.nl/api/v1/businesses/{id}/delete \
    -H "Authorization: Bearer {token}"
    -H "Accept: application/json" \

Response

{
    "message": "ok"
}