User details for mandates

When you create a mandate, you need to provide user details as part of anti-money-laundering measures. The only exception to this is if you have a PISP license.

User details to collect

When you create a mandate, you provide user details in the user object. The available fields in the user object are: id, name, email, phone, date_of_birthandaddress.

For a mandate, you must provide a minimum of:

The name of the payer, their given and family name.
One of:
- The payer's email address.
- The payer's phone number.

How to collect details

The example request below shows a mandate creation request with the mandatory user detail objects name and email completed. It also includes values for the non-mandatory id and phone objects.

curl --request POST \
     --url https://api.truelayer-sandbox.com/mandates \
     --header "Content-Type: application/json" \
     --header "Idempotency-Key: $(uuidgen)" \
     --header "Tl-Signature: TestRequest..Signature' \
     --header "Authorization: Bearer $AUTH_TOKEN" \
     --data '{
  "mandate": {
    "type": "sweeping",
    "provider_selection": {
       "filter": {
          "countries": ["GB"],
          "release_channel": "private_beta"
       },
       "type": "user_selected"
    },
    "beneficiary": {
       "type": "external_account",
       "account_holder_name": "My Bank Account",
       "account_identifier": {
          "type": "sort_code_account_number",
          "sort_code": "111111",
          "account_number": "10001000"
       },
    }
  },
  "currency": "GBP",
  "user": {
    "id": "f9b48c9d-176b-46dd-b2da-fe1a2b77350c",
    "name": "Remi Terr",
    "email": "[email protected]",
    "phone": "+44777777777"
  },
  "constraints": {
    "valid_from": "2022-05-10T00:00:00.000Z",
    "valid_to": "2022-05-11T00:00:00.000Z",
    "maximum_individual_amount": 100,
    "periodic_limits": {
      "week": {
        "maximum_amount": 1000,
        "period_alignment": "calendar"
      }
    }
  }
}'