API Reference

Welkom bij de Flireo API-documentatie. Hier vind je alle informatie die je nodig hebt om te integreren met ons platform.

Aan de slag!

Begin met het bekijken van de Authenticatie sectie om te leren hoe je API-verzoeken kunt autoriseren.

Authenticatie

Alle API-verzoeken moeten worden geauthenticeerd met een Bearer Token. Je kunt je API-sleutel vinden in je dashboard.

Authorization header:

Authorization: Bearer UW_API_TOKEN

Foutafhandeling

De API gebruikt standaard HTTP-statuscodes. 2xx voor succes,4xx voor clientfouten,5xx voor serverfouten.

Voorbeeld foutresponse:

{
  "error": {
    "code": "invalid_request",
    "message": "Ongeldige parameters",
    "details": {
      "name": "Dit veld is verplicht"
    }
  }
}

Rate Limiting

Om de stabiliteit te garanderen, hanteren we rate limits van 100 verzoeken per minuut per API-sleutel.

Response headers:

X-RateLimit-Limit - Maximaal aantal verzoeken
X-RateLimit-Remaining - Resterende verzoeken
X-RateLimit-Reset - Reset timestamp

Assistenten ophalen

Haalt een lijst op van alle assistenten van de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
limit	number	query	Maximaal aantal resultaten (standaard: 20, max: 100)
offset	number	query	Aantal resultaten om over te slaan voor paginering

GET/v1/assistants

Code Examples

curl -X GET "https://api.flireo.nl/v1/assistants?limit=20&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Assistent aanmaken

Maakt een nieuwe assistent aan. Alle velden zijn verplicht.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
assistant_name*	string	body	Naam van de assistent
llm_content*	string	body	Instructies voor de AI assistent over hoe deze zich moet gedragen
first_message*	string	body	Het eerste bericht dat de assistent zegt bij inkomende gesprekken
end_call_message*	string	body	Het bericht dat wordt afgespeeld aan het einde van een gesprek
voicemail_message*	string	body	Het bericht dat wordt afgespeeld voor voicemail
functions*	string	body	JSON string met beschikbare functies voor de assistent
first_message_outbound*	string	body	Het eerste bericht voor uitgaande gesprekken
booking_message*	string	body	Het bericht voor het inplannen van afspraken

POST/v1/assistants

Code Examples

curl -X POST "https://api.flireo.nl/v1/assistants" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_name": "Nieuwe Klantenservice Assistent",
    "llm_content": "Je bent een vriendelijke en behulpzame klantenservice assistent.",
    "first_message": "Hallo! Welkom bij onze klantenservice.",
    "end_call_message": "Bedankt voor je gesprek met ons.",
    "voicemail_message": "Je hebt de voicemail bereikt.",
    "functions": "[]",
    "first_message_outbound": "Goedemiddag, ik bel namens ons bedrijf.",
    "booking_message": "Ik kan een afspraak inplannen."
  }'

Assistent ophalen

Haalt de details op van een specifieke assistent.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
assistant_id*	string	path	ID van de assistent

GET/v1/assistants/{assistant_id}

Code Examples

curl -X GET "https://api.flireo.nl/v1/assistants/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Assistent bijwerken

Werkt een bestaande assistent bij. Alle velden zijn optioneel.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
assistant_id*	string	path	ID van de assistent
assistant_name	string	body	Naam van de assistent
llm_content	string	body	Instructies voor de AI assistent over hoe deze zich moet gedragen
first_message	string	body	Het eerste bericht dat de assistent zegt bij inkomende gesprekken
end_call_message	string	body	Het bericht dat wordt afgespeeld aan het einde van een gesprek
voicemail_message	string	body	Het bericht dat wordt afgespeeld voor voicemail
functions	string	body	JSON string met beschikbare functies voor de assistent
first_message_outbound	string	body	Het eerste bericht voor uitgaande gesprekken
booking_message	string	body	Het bericht voor het inplannen van afspraken

PUT/v1/assistants/{assistant_id}

Code Examples

curl -X PUT "https://api.flireo.nl/v1/assistants/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_name": "Bijgewerkte Klantenservice Assistent",
    "first_message": "Hallo! Ik ben je bijgewerkte assistent.",
    "llm_content": "Je bent een zeer ervaren klantenservice assistent."
  }'

Assistent verwijderen

Verwijdert een assistent.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
assistant_id*	string	path	ID van de assistent

DELETE/v1/assistants/{assistant_id}

Code Examples

curl -X DELETE "https://api.flireo.nl/v1/assistants/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Telefoonnummer koppelen aan assistent

Koppelt een custom telefoonnummer aan een assistent of ontkoppelt een bestaand telefoonnummer. Alleen custom telefoonnummers kunnen via deze API worden gekoppeld.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
assistant_id*	string	path	ID van de assistent
phoneNumberId*	string \| null	body	ID van het telefoonnummer om te koppelen, of null om te ontkoppelen

PUT/v1/assistants/{assistant_id}/phone-number

Code Examples

# Telefoonnummer koppelen
curl -X PUT "https://api.flireo.nl/v1/assistants/123e4567-e89b-12d3-a456-426614174000/phone-number" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumberId": "phn_123e4567-e89b-12d3-a456-426614174000"
  }'

# Telefoonnummer ontkoppelen
curl -X PUT "https://api.flireo.nl/v1/assistants/123e4567-e89b-12d3-a456-426614174000/phone-number" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumberId": null
  }'

Gesprekken ophalen

Haalt alle gesprekken op van de geauthenticeerde gebruiker met optionele filters.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
assistant_id	string	query	Filter op assistent ID
contact_id	string	query	Filter op contact ID
call_status	string	query	Filter op gespreksstatus (completed, missed, etc.)
start_date	string	query	Filter op startdatum (YYYY-MM-DD)
end_date	string	query	Filter op einddatum (YYYY-MM-DD)
limit	integer	query	Aantal resultaten per pagina Standaard: `10`
offset	integer	query	Aantal resultaten om over te slaan Standaard: `0`

GET/v1/calls

Code Examples

curl -X GET "https://api.flireo.nl/v1/calls?assistant_id=123e4567-e89b-12d3-a456-426614174000&limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Gesprek details ophalen

Haalt de details van een specifiek gesprek op.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
call_id*	string	path	ID van het gesprek

GET/v1/calls/{call_id}

Code Examples

curl -X GET "https://api.flireo.nl/v1/calls/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Direct gesprek starten

Start direct een telefoongesprek tussen een assistent en een contact.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
assistant_id*	string	body	ID van de assistent die het gesprek moet voeren
contact_id	string	body	ID van het contact dat gebeld moet worden. Ofwel contact_id OF contact_phone_number moet worden opgegeven.
contact_phone_number	string	body	Telefoonnummer om direct te bellen. Ofwel contact_id OF contact_phone_number moet worden opgegeven.
custom_data	object	body	Aangepaste gegevens die aan het gesprek moeten worden toegevoegd

POST/v1/calls/direct

Code Examples

curl -X POST "https://api.flireo.nl/v1/calls/direct" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_id": "123e4567-e89b-12d3-a456-426614174000",
    "contact_id": "123e4567-e89b-12d3-a456-426614174001",
    "custom_data": {
      "reason": "Follow-up gesprek",
      "notes": "Bespreken van recente bestelling"
    }
  }'

Contacten ophalen

Haalt alle contacten op van de geauthenticeerde gebruiker met optionele filters.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
org_id	string	query	Filter op organisatie ID
full_name	string	query	Filter op naam (gedeeltelijke overeenkomst)
email	string	query	Filter op e-mailadres (exacte overeenkomst)
phone_number	string	query	Filter op telefoonnummer (exacte overeenkomst)
limit	integer	query	Aantal resultaten per pagina Standaard: `10`
offset	integer	query	Aantal resultaten om over te slaan Standaard: `0`

GET/v1/contacts

Code Examples

curl -X GET "https://api.flireo.nl/v1/contacts?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Contact aanmaken

Maakt een nieuw contact aan voor de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
Content-Type*	string	header	application/json
phone_number*	string	body	Telefoonnummer in E.164 formaat (bijv. +31612345678)
full_name	string	body	Volledige naam van het contact
email	string	body	E-mailadres van het contact
address	string	body	Adres van het contact
last_interaction_at	string	body	Datum en tijd van de laatste interactie (ISO 8601 formaat)
last_interaction_summary	string	body	Samenvatting van de laatste interactie
org_id	string	body	ID van de organisatie waartoe het contact behoort

POST/v1/contacts

Code Examples

curl -X POST "https://api.flireo.nl/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+31612345678",
    "full_name": "Pieter Janssen",
    "email": "pieter@example.com",
    "address": "Kerkstraat 45, Rotterdam",
    "last_interaction_at": "2025-05-03T15:00:00.000Z",
    "last_interaction_summary": "Eerste contact gelegd over nieuwe dienst",
    "org_id": "2f8f1af1-1d27-498b-9645-805d0698aa63"
  }'

Contact details ophalen

Haalt de details van een specifiek contact op.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
contact_id*	string	path	ID van het contact

GET/v1/contacts/{contact_id}

Code Examples

curl -X GET "https://api.flireo.nl/v1/contacts/ae150595-f90d-4233-b480-fdab2a65085f" \
  -H "Authorization: Bearer YOUR_API_KEY"

Contact bijwerken

Werkt de gegevens van een bestaand contact bij.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
Content-Type*	string	header	application/json
contact_id*	string	path	ID van het contact
phone_number	string	body	Telefoonnummer in E.164 formaat (bijv. +31612345678)
full_name	string	body	Volledige naam van het contact
email	string	body	E-mailadres van het contact
address	string	body	Adres van het contact
last_interaction_at	string	body	Datum en tijd van de laatste interactie (ISO 8601 formaat)
last_interaction_summary	string	body	Samenvatting van de laatste interactie
meeting_date	string	body	Datum en tijd van een geplande meeting (ISO 8601 formaat)
meeting_event_id	string	body	ID van het meeting event in een externe kalender

PUT/v1/contacts/{contact_id}

Code Examples

curl -X PUT "https://api.flireo.nl/v1/contacts/ae150595-f90d-4233-b480-fdab2a65085f" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Joost Klein-Jansen",
    "email": "joost@example.com",
    "address": "Marktplein 12, Utrecht",
    "last_interaction_at": "2025-05-03T16:00:00.000Z",
    "last_interaction_summary": "Vervolg gesprek over project X",
    "meeting_date": "2025-05-10T14:00:00.000Z"
  }'

Contact verwijderen

Verwijdert een contact (soft delete).

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
contact_id*	string	path	ID van het contact

DELETE/v1/contacts/{contact_id}

Code Examples

curl -X DELETE "https://api.flireo.nl/v1/contacts/ae150595-f90d-4233-b480-fdab2a65085f" \
  -H "Authorization: Bearer YOUR_API_KEY"

Geplande gesprekken ophalen

Haalt een lijst op van alle geplande gesprekken voor de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
limit	number	query	Aantal resultaten per pagina (standaard: 10)
offset	number	query	Aantal resultaten om over te slaan (standaard: 0)
assistant_id	string	query	Filter op assistent ID
contact_id	string	query	Filter op contact ID
processed	boolean	query	Filter op verwerkt (true/false)

GET/v1/scheduled-calls

Code Examples

curl -X GET "https://api.flireo.nl/v1/scheduled-calls?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Gepland gesprek aanmaken

Maakt een nieuw gepland gesprek aan voor de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
contact_id*	string	body	ID van het contact
assistant_id*	string	body	ID van de assistent
scheduled_time*	string	body	Geplande tijd voor het gesprek (ISO 8601 formaat)
instruction	string	body	Instructies voor het gesprek

POST/v1/scheduled-calls

Code Examples

curl -X POST "https://api.flireo.nl/v1/scheduled-calls" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "223e4567-e89b-12d3-a456-426614174001",
    "assistant_id": "323e4567-e89b-12d3-a456-426614174002",
    "scheduled_time": "2023-06-15T14:30:00.000Z",
    "instruction": "Bel om te informeren over nieuwe diensten"
  }'

Gepland gesprek details ophalen

Haalt de details op van een specifiek gepland gesprek.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
scheduled_call_id*	string	path	ID van het geplande gesprek

GET/v1/scheduled-calls/{scheduled_call_id}

Code Examples

curl -X GET "https://api.flireo.nl/v1/scheduled-calls/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Gepland gesprek bijwerken

Werkt een bestaand gepland gesprek bij.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
scheduled_call_id*	string	path	ID van het geplande gesprek
scheduled_time	string	body	Nieuwe geplande tijd voor het gesprek (ISO 8601 formaat)
instruction	string	body	Nieuwe instructies voor het gesprek
processed	boolean	body	Markeer het gesprek als verwerkt

PUT/v1/scheduled-calls/{scheduled_call_id}

Code Examples

curl -X PUT "https://api.flireo.nl/v1/scheduled-calls/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduled_time": "2023-06-16T15:00:00.000Z",
    "instruction": "Bijgewerkte instructies voor het gesprek",
    "processed": true
  }'

Gepland gesprek verwijderen

Verwijdert een gepland gesprek.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
scheduled_call_id*	string	path	ID van het geplande gesprek

DELETE/v1/scheduled-calls/{scheduled_call_id}

Code Examples

curl -X DELETE "https://api.flireo.nl/v1/scheduled-calls/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Gebruikersprofiel ophalen

Haalt het profiel op van de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie

GET/v1/user/profile

Code Examples

curl -X GET "https://api.flireo.nl/v1/user/profile" \
  -H "Authorization: Bearer YOUR_API_KEY"

Gebruikersprofiel bijwerken

Werkt het profiel bij van de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
full_name	string	body	Volledige naam van de gebruiker
company_name	string	body	Bedrijfsnaam
phone_number	string	body	Telefoonnummer van de gebruiker

PATCH/v1/user/profile

Code Examples

curl -X PATCH "https://api.flireo.nl/v1/user/profile" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Jane Doe",
    "company_name": "Nieuw Bedrijf BV",
    "phone_number": "+31687654321"
  }'

Telefoonnummers ophalen

Haalt alle telefoonnummers op die aan de geauthenticeerde gebruiker zijn gekoppeld, zowel custom als default nummers.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie

GET/v1/phone-numbers

Code Examples

curl -X GET "https://api.flireo.nl/v1/phone-numbers" \
  -H "Authorization: Bearer YOUR_API_KEY"

Telefoonnummer toevoegen

Voegt een nieuw telefoonnummer toe aan het abonnement van de gebruiker. Vereist een actief abonnement.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
phone_number*	string	body	Het telefoonnummer dat moet worden toegevoegd (E.164 formaat)
verification_group_id*	string	body	ID van een goedgekeurde verificatiegroep

POST/v1/phone-numbers

Code Examples

curl -X POST "https://api.flireo.nl/v1/phone-numbers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+31612345678",
    "verification_group_id": "123e4567-e89b-12d3-a456-426614174000"
  }'

Telefoonnummer verwijderen

Verwijdert een telefoonnummer uit het abonnement van de gebruiker. Alleen mogelijk als er geen assistent aan gekoppeld is en het een custom nummer betreft.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
id*	string	path	ID van het telefoonnummer dat moet worden verwijderd

DELETE/v1/phone-numbers/{id}

Code Examples

curl -X DELETE "https://api.flireo.nl/v1/phone-numbers/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Beschikbare telefoonnummers voor verificatiegroep

Haalt beschikbare telefoonnummers op voor een specifieke verificatiegroep op basis van de locatie van de groep.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
id*	string	path	ID van de verificatiegroep
limit	integer	query	Aantal resultaten per pagina (standaard: 10) Standaard: `10`

GET/v1/verification-groups/{id}/available-phone-numbers

Code Examples

curl -X GET "https://api.flireo.nl/v1/verification-groups/123e4567-e89b-12d3-a456-426614174000/available-phone-numbers?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Telefoonnummer bestellingen ophalen

Haalt alle lopende telefoonnummer bestellingen op voor de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
status	string	query	Filter op status (pending, completed, failed)
limit	integer	query	Aantal resultaten per pagina (standaard: 20) Standaard: `20`
offset	integer	query	Aantal resultaten om over te slaan Standaard: `0`

GET/v1/phone-number-orders

Code Examples

curl -X GET "https://api.flireo.nl/v1/phone-number-orders?status=pending&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

Verificatiegroepen ophalen

Haalt een lijst op van alle verificatiegroepen voor de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
limit	number	query	Aantal resultaten per pagina (standaard: 10)
offset	number	query	Aantal resultaten om over te slaan (standaard: 0)
status	string	query	Filter op status (pending, approved, rejected)

GET/v1/verification-groups

Code Examples

curl -X GET "https://api.flireo.nl/v1/verification-groups?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Verificatiegroep aanmaken

Maakt een nieuwe verificatiegroep aan voor de geauthenticeerde gebruiker.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
name*	string	body	Naam van de verificatiegroep
business_name*	string	body	Naam van het bedrijf
contact_person_first_name*	string	body	Voornaam van de contactpersoon
contact_person_last_name*	string	body	Achternaam van de contactpersoon
contact_person_phone*	string	body	Telefoonnummer van de contactpersoon (Nederlands formaat)
city*	string	body	Plaatsnaam
street_name*	string	body	Straatnaam
house_number*	string	body	Huisnummer (inclusief toevoeging indien van toepassing)
postal_code*	string	body	Postcode (Nederlands formaat: 1234AB)
province*	string	body	Provincie
description	string	body	Optionele beschrijving van de verificatiegroep

POST/v1/verification-groups

Code Examples

curl -X POST "https://api.flireo.nl/v1/verification-groups" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mijn Bedrijf Verificatie",
    "business_name": "Flireo BV",
    "contact_person_first_name": "Jan",
    "contact_person_last_name": "de Vries",
    "contact_person_phone": "+31612345678",
    "city": "Amsterdam",
    "street_name": "Damrak",
    "house_number": "1",
    "postal_code": "1012LG",
    "province": "Noord-Holland",
    "description": "Verificatie voor telefoonnummer aanvraag"
  }'

Verificatiegroep details ophalen

Haalt de details op van een specifieke verificatiegroep.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
verification_group_id*	string	path	ID van de verificatiegroep

GET/v1/verification-groups/{verification_group_id}

Code Examples

curl -X GET "https://api.flireo.nl/v1/verification-groups/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Verificatiegroep indienen voor goedkeuring

Dient een verificatiegroep in voor goedkeuring. Alle vereiste documenten moeten zijn geüpload voordat deze actie kan worden uitgevoerd.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
verification_group_id*	string	path	ID van de verificatiegroep

POST/v1/verification-groups/{verification_group_id}/submit-for-approval

Vereisten

Voordat een verificatiegroep kan worden ingediend voor goedkeuring, moeten alle volgende documenten zijn geüpload:

• KVK-uittreksel (external_company_registration_file_id)
• Kopie identiteitsbewijs (external_identification_file_id)
• Adresbewijs (external_proof_of_address_file_id)
• Adresgegevens (external_address_id)

Code Examples

curl -X POST "https://api.flireo.nl/v1/verification-groups/123e4567-e89b-12d3-a456-426614174000/submit-for-approval" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Verificatiegroep verwijderen

Verwijdert een verificatiegroep. Dit kan alleen als er geen documenten meer gekoppeld zijn aan de verificatiegroep.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
verification_group_id*	string	path	ID van de verificatiegroep

DELETE/v1/verification-groups/{verification_group_id}

Vereisten

Een verificatiegroep kan alleen worden verwijderd als alle documenten eerst zijn verwijderd. Verwijder eerst alle gekoppelde documenten voordat je de verificatiegroep verwijdert.

Code Examples

curl -X DELETE "https://api.flireo.nl/v1/verification-groups/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Document uploaden

Upload een document voor een verificatiegroep. Ondersteunde bestandsformaten zijn PDF, JPG en PNG.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
Content-Type*	string	header	multipart/form-data
verification_group_id*	string	path	ID van de verificatiegroep
document_type*	string	form	Type document: 'company-registration' (KVK-uittreksel), 'proof-of-address' (adresbewijs), 'copy-id' (kopie identiteitsbewijs)
file*	file	form	Het document bestand (PDF, JPG, PNG)

POST/v1/verification-groups/{verification_group_id}/documents

Code Examples

curl -X POST "https://api.flireo.nl/v1/verification-groups/123e4567-e89b-12d3-a456-426614174000/documents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "document_type=company-registration" \
  -F "file=@/path/to/kvk-uittreksel.pdf"

Document verwijderen

Verwijdert een specifiek document uit een verificatiegroep.

Parameters

Naam	Type	Locatie	Beschrijving
Authorization*	string	header	Bearer token voor authenticatie
verification_group_id*	string	path	ID van de verificatiegroep
document_id*	string	path	ID van het document

DELETE/v1/verification-groups/{verification_group_id}/documents/{document_id}

Code Examples

curl -X DELETE "https://api.flireo.nl/v1/verification-groups/123e4567-e89b-12d3-a456-426614174000/documents/323e4567-e89b-12d3-a456-426614174002" \
  -H "Authorization: Bearer YOUR_API_KEY"