Skip to main content

​
Onboarding agence

Les agences de transport professionnelles peuvent s’inscrire sur ColisMove pour gérer des envois en volume, plusieurs branches et des employés.

​
Flux d’onboarding

​
Étape 1 : Inscrire l’agence

POST /v1/api/agencies/register
{
  "name": "Express Transport SARL",
  "description": "Professional transport agency",
  "phoneNumber": "+33612345678",
  "address": "123 Rue du Commerce, Paris",
  "city": "Paris",
  "country": "FR"
}

​
Étape 2 : Téléverser les documents KYC

Téléverser les documents d’entreprise requis : 
POST /v1/api/agencies/{id}/kyc/documents
Content-Type: multipart/form-data

file: [business-registration.pdf]
Documents requis :
  • Justificatif d’immatriculation (KBIS ou équivalent)
  • Document d’identification fiscale
  • Justificatif d’adresse
  • Pièce d’identité du dirigeant
Vérifier le statut des documents : 
GET /v1/api/agencies/{id}/kyc/documents

​
Étape 3 : Onboarding Stripe Connect

Une fois les documents KYC approuvés : 
POST /v1/api/agencies/{id}/stripe-onboard
Renvoie une URL d’onboarding Stripe pour la configuration bancaire de l’agence.

​
Étape 4 : Créer des branches

Ajouter des emplacements physiques : 
POST /v1/api/agencies/{id}/branches
{
  "name": "Paris Gare du Nord",
  "address": "18 Rue de Dunkerque, 75010 Paris",
  "phoneNumber": "+33612345679",
  "latitude": 48.8809,
  "longitude": 2.3553
}

​
Étape 5 : Ajouter des employés

Inviter les membres de l’équipe : 
POST /v1/api/agencies/{id}/employees
{
  "userId": 456,
  "role": "AGENT"
}

​
Portefeuille de l’agence

Consulter les gains de l’agence : 
GET /v1/api/agencies/{id}/wallet
Demander un retrait : 
POST /v1/api/agencies/{id}/withdraw
{
  "amount": 500.00
}

​
Gestion de l’agence

EndpointDescription
GET /agencies/my-agencyRécupère les détails de votre agence
PUT /agencies/{id}Met à jour les informations de l’agence
GET /agencies/{id}/branchesListe toutes les branches
GET /agencies/{id}/employeesListe tous les employés
DELETE /agencies/{id}/employees/{userId}Retire un employé
Les propriétaires d’agence ont le rôle ROLE_VERIFIED_USER et gèrent leur agence de manière autonome. Les super administrateurs peuvent suspendre une agence via PATCH /superadmin/agencies/{id}/suspend.