Riders

Invite a rider

POST/api/v1/riders

Creates a rider account for the seller and emails them a verification code to complete onboarding.

Requires Authorization

SELLER only

Authenticated action

Body parameters

`name`stringrequired
`email`stringrequired
`phone`stringrequired
`locale`string	en or fr — controls the invite email language.

Request

curl --request POST \
  --url https://api.swiftgoma.com/api/v1/riders \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Aline Mapendo",
  "email": "aline@example.com",
  "phone": "<phone>",
  "locale": "fr"
}'

201Example response

{
  "success": true,
  "data": {
    "userId": "9c8d7e6f",
    "riderId": "rider_1a2b3c",
    "status": "PENDING"
  }
}