Referred Onboarding API (1.0.0)

Download OpenAPI specification:

Refer your users to VEROO to receive their signals.

Create a referral

Refer a user of an organisation to VEROO, optionally supplying company data that will streamline the registration process in VEROO.

Request Body schema: application/json
required
CompanyEmailAddress
required
string <email>

The user's email address. The invitation email will be sent to this address by VEROO.

CompanyPartnerReference
string

The identifier that you use to identify the user's organisation. If present, this value will be attached to signals sent to you by VEROO.

CompanyVAT
string

The VAT of the user's organisation.

CompanyName
string

The name of the user's organisation.

CompanyStreet
string

The street of the user's organisation's address.

CompanyHouse
string

The house number of the user's organisation's address.

CompanyPostal
string

The postal code of the user's organisation's address.

CompanyCity
string

The city of the user's organisation's address.

CompanyCountryCode
string

The ISO 3166-1 alpha-2 country code of the user's organisation's address.

CompanyAdditionalInformation
string

Some other information of the user's organisation address.

CompanyPhoneNumber
string

The phone number of the user's organisation.

Responses

Request samples

Content type
application/json
{
  • "CompanyEmailAddress": "user@example.com",
  • "CompanyPartnerReference": "string",
  • "CompanyVAT": "string",
  • "CompanyName": "string",
  • "CompanyStreet": "string",
  • "CompanyHouse": "string",
  • "CompanyPostal": "string",
  • "CompanyCity": "string",
  • "CompanyCountryCode": "string",
  • "CompanyAdditionalInformation": "string",
  • "CompanyPhoneNumber": "string"
}