Customers

The Customer are (natural) persons within the OnRamp ecosystem. Use this endpoint to collect personal information, validate identity documents, and perform real-time checks against regulatory watchlists. This process ensures compliance with legal obligations and enhances trust by verifying the identity of your end-users.

The customer model

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

Properties

Name
id
Type
string|uuid
Description
Unique identifier of the customer.
Name
notes
Type
array
Description
Notes added for the customer by you.
Name
business_id
Type
string|uuid
Description
Unique identifier of the associated business.
Name
initials
Type
string
Description
Initials of the customer.
Name
firstname
Type
string
Description
First name of the customer.
Name
lastname
Type
string
Description
Last name of the customer.
Name
name
Type
string
Description
Full name of the customer.
Name
email
Type
string
Description
Email address of the customer.
Name
gender
Type
string
Description
Gender of the customer.
Name
birthdate
Type
date
Description
Birthdate of the customer.
Name
nationality_id
Type
integer
Description
Identifier of the nationality of the customer.
Name
document_number
Type
string
Description
Document number of the customer.
Name
document_expiration
Type
datetime
Description
Expiration date of the customer's document.
Name
document_type
Type
integer
Description
Type of the customer's document.
Name
phone
Type
string
Description
Phone number of the customer.
Name
address
Type
string
Description
Address of the customer.
Name
street
Type
string
Description
Street of the customer.
Name
housenumber
Type
int
Description
House number of the customer.
Name
addition
Type
string
Description
Address addition of the customer.
Name
postalcode
Type
string
Description
Postal code of the customer.
Name
city
Type
string
Description
City of the customer.
Name
country_id
Type
integer
Description
Identifier of the country associated with the customer.
Name
iban_number
Type
string
Description
IBAN number associated with the customer.
Name
is_active
Type
boolean
Description
Indicates if the customer is active.
Name
inactive_at
Type
datetime
Description
Timestamp of when the customer was deactivated.
Name
created_at
Type
datetime
Description
Timestamp of when the customer was created.
Name
updated_at
Type
datetime
Description
Timestamp of the last update to the customer.

Optional properties

Name
iban_check
Type
array
Description
All data related to the last IBAN check.
Name
idin_check
Type
array
Description
All data related to the last IDIN check.
Name
idscan_check
Type
array
Description
All data related to the last IDSCAN check.

POSTapi/v1/customers/create

Create a customer

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

Required attributes

Name
initials
Type
string|max:255
Description
Initials of the customer, optional.
Name
firstname
Type
string|max:255
Description
First name of the customer, optional.
Name
lastname
Type
string|max:255
Description
Last name of the customer, optional.
Name
name
Type
string|max:255
Description
Full name of the customer, required.
Name
business_id
Type
null|uuid
Description
Unique identifier of the associated business, optional.
Name
email
Type
string
Description
Email address of the customer. Required, must be a valid email format.
Name
country_code
Type
string|size:3
Description
Country code of the customer. Required, must be ISO3 and an EU country.
Name
phone
Type
string|min:10
Description
Phone number of the customer. Optional, must match a valid phone number format and have a minimum length of 10 characters.
Name
iban_number
Type
string|max:255
Description
IBAN number associated with the customer. Optional, maximum length of 255 characters.
Name
address
Type
string
Description
Address of the customer. Optional.
Name
city
Type
string
Description
City of the customer. Optional.
Name
postalcode
Type
string
Description
Postal code of the customer. Optional.
Name
birthdate
Type
date
Description
Birthdate of the customer. Optional, must be a valid date and the customer must be at least 18 years old.
Name
checks
Type
array
Description
List of checks queued for the customer. Required.
Name
checks.idin
Type
boolean
Description
Indicates if the IDIN check url must be made. Required.
Name
checks.idscan
Type
boolean
Description
Indicates if the ID scan check url must be made. Required.
Name
checks.iban
Type
boolean
Description
Indicates if the IBAN check must be queued. Required.
Name
mails
Type
boolean
Description
Indicates whether the verification URLs are sent through mail or instantly returned by URL, optional.

Request

POST

api/v1/customers/create

curl -X POST https://app.onramp.nl/api/v1/customers/create \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "initials": "J.D.",
    "firstname": "John",
    "lastname": "Doe",
    "name": "John Doe",
    "email": "johndoe@gmail.nl",
    "country_code": "NLD",
    "phone": "+31612345678",
    "iban_number": "NL91ABNA1234567890",
    "address": "Main Street 1",
    "city": "Amsterdam",
    "postalcode": "1234 AB",
    "birthdate": "1990-01-01",
    "checks": {
      "idin": true,
      "idscan": true,
      "iban": true
    },
    "mails": true
  }'

Response

{
    "id": "4ba4a08a-9500-4cef-8a96-3f8e4ab92adf",
    "initials": "J.D.",
    "firstname": "John",
    "lastname": "Doe",
    "name": "John Doe",
    "email": "johndoe@gmail.nl",
    "iban_number": "NL91ABNA1234567890",
    "phone": "+31612345678",
    "address": "Main Street 1",
    "city": "Amsterdam",
    "postalcode": "1234 AB",
    "country_id": 148,
    "birthdate": "1990-01-01",
    "updated_at": "2025-04-30T12:01:52.000000Z",
    "created_at": "2025-04-30T12:01:52.000000Z",
    "messages": [
        "IBAN Check has been queued"
    ],
    "mails": {
        "idin": true,
        "idscan": true
    }
}

POSTapi/v1/customers/{id}/check

Create a customer Check request

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

Request

POST

api/v1/customers/{id}/check

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

Response

{
    "messages": [
        "IBAN Check has been queued",
        "AML Check has been queued",
    ],
    "urls": [
      "idin": "https://example.com/idin/start",
      "idscan": "https://example.com/idscan/start",
    ]
}

GETapi/v1/customers

Get a list of all customers

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

Request

GET

api/v1/customers

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

Response

{
    "data": [
        {
            "id": "11afc4ed-5d32-4c04-b09f-b299bd5f421c",
            "business_id": null,
            "name": "New Customer",
            "email": "Newcustomer@gmail.com",
            "is_active": 1,
            "inactive_at": null,
            "created_at": "2025-04-16T11:49:31.000000Z",
            "updated_at": "2025-04-16T11:49:31.000000Z"
        },
        {
            "id": "13fe82ce-90a4-4df8-a8c3-6bae57331dc5",
            "business_id": null,
            "name": "John Doe",
            "email": "johndoe@gmail.nl",
            "is_active": 1,
            "inactive_at": null,
            "created_at": "2025-04-30T12:01:22.000000Z",
            "updated_at": "2025-04-30T12:01:22.000000Z"
        },
        ......
        ......
        ......
    ],
    "path": "https://app.onramp.nl/api/v1/customers",
    "per_page": 20,
    "next_cursor": "eyJjdXN0b21lcnNfOWU5NDQ1NDYtMjZkNC00MDIzLWE1NGItZTg3MzFmOTY3ZGJmLmlkIjoiMjZmNzc2OGEtMTczZi00ODk4LWJjNzUtYmZkZTYyOWM1Y2U2IiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
    "next_page_url": "https://app.onramp.nl/api/v1/customers?cursor=eyJjdXN0b21lcnNfOWU5NDQ1NDYtMjZkNC00MDIzLWE1NGItZTg3MzFmOTY3ZGJmLmlkIjoiMjZmNzc2OGEtMTczZi00ODk4LWJjNzUtYmZkZTYyOWM1Y2U2IiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
    "prev_cursor": null,
    "prev_page_url": null
}

GETapi/v1/customers/{id}

Get a customer by UUID

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

Request

GET

api/v1/customers

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

Response

{
    "id": "0095571d-dc02-40d5-8313-69a1b1e54cec",
    "business_id": null,
    "notes": null,
    "initials": "J.D.",
    "firstname": "John",
    "lastname": "Doe",
    "name": "John Doe",
    "email": "John.doe@mail.com",
    "gender": null,
    "birthdate": "1990-01-01",
    "nationality_id": 148,
    "document_number": null,
    "document_expiration": null,
    "document_type": null,
    "phone": "+31612345678",
    "address": "Straatnaam 1",
    "street": "Straatnaam",
    "housenumber": "1",
    "addition": null,
    "postalcode": "1234 AB",
    "city": "Stad",
    "country_id": 148,
    "iban_number": "NL91ABNA1234567890",
    "is_active": 1,
    "inactive_at": null,
    "created_at": "2025-04-25T09:04:36.000000Z",
    "updated_at": "2025-04-25T09:04:36.000000Z"
}

DELETEapi/v1/customers/

Delete a customer

Delete a customer by UUID in your OnRamp environment.

Request

DELETE

api/v1/customers/{id}/delete

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

Response

{
    "message": "ok"
}