v1

latestOpenAPI 3.1.02026-07-2419077.8 KB

Retrieve a Lead

This endpoint retrieves the details of a lead that was previously created.

get/{lead_id}

Path parameters

lead_idstring required

The ID of the Lead which needs to be retrieved.

Response

200

idstring

reference_lead_idstring

Example response

{
  "id": "led_xxxx",
  "brand": {
    "name": {
      "en": "merchantNameEn",
      "ar": "merchantNameAr"
    },
    "logo": "file_656848322076980748",
    "operations": {
      "sales": {
        "period": "monthly",
        "range": {
          "from": "10000",
          "to": "80000"
        },
        "currency": "AED"
      }
    },
    "channel_services": [
      {
        "channel": "website",
        "address": "https://www.website.company/"
      }
    ]
  },
  "entity": {
    "country": "AE",
    "is_licensed": true,
    "license": {
      "number": "1010000000",
      "country": "AE",
      "type": "commercial_registration"
    },
    "tax": {
      "number": "123456789",
      "issuing_date": "2022-01-01",
      "expiry_date": "2025-01-01"
    }
  },
  "wallet": {
    "bank": {
      "name": "ADIB",
      "account": {
        "name": "ABC",
        "number": "77777777777",
        "swift": "77777777777",
        "iban": "SA000000000000000009"
      }
    }
  },
  "user": {
    "name": {
      "lang": "en",
      "title": "Mr",
      "first": "John",
      "last": "Doe"
    },
    "nationality": "AE",
    "identification": {
      "number": "00000000",
      "type": "national_id",
      "issuer": "AE"
    },
    "birth": {
      "country": "AE",
      "city": "Dubai",
      "date": "1990-01-01"
    },
    "primary": true
  },
  "post": {
    "url": "https://merchant.company/post_url"
  },
  "metadata": {
    "param1": "value"
  },
  "reference_lead_id": "xxx"
}