Handover code generation

Deliveroo currently offers the generation of a 2 digit handover code on behalf of the partner as a feature.

The handover code is a code exchanged by the rider and the customer at cargo handover time to ensure that the cargo is delivered to the right recipient.

The current API allows partners to pass a 2 digit code of their choice. If the partner does so, Deliveroo will use the provided code and will not generate one.

If no verification code is provided and the partner explicitly specifies that they would want it generated for them, Deliveroo will generate a 2 digit code for the partner and communicate it to the rider.

How to request a handover code generation ?

The verification field in the Accept quote endpoint is used to signal whether the partner wants Deliveroo to generate handover code for them.

The following format in the Accept quote call is expected if the partner requires Deliveroo to generate the handover code:

{
  "verification": {
    "type": "CODE"
  }
}

Please note that in this case, the value field should not be set.

The partner will be notified of the newly generated handover code via:

• The Accept quote endpoint response
• The Get delivery endpoint
• The delivery.update_status webhook event with the verification field set to CODE and the value field set to the generated code.

Example payload of webhook:

{
  "event": "delivery.update_status",
  "body": {
    "delivery_id": "f7e458ec-3d8e-4271-9a25-34d2fa125782",
    "external_ref_id": "6823e970-283d-4bfd-849e-7bcb0e4a1b40#courier",
    "verification": {
        "type": "CODE",
        "value": "45"
    }
    "status": {
      "effective_at": "2024-07-10T11:23:09Z",
      "status": "ACTIVE"
    }
  }
}