Create a Lead

Create a Lead

POST /leads

Error

A valid request URL is required to generate request examples

201

{
  "Data": {
    "LeadId": "<string>",
    "Email": "[e-mail]",
    "Name": {
      "GivenName": "<string>",
      "LastName": "<string>"
    },
    "PhoneNumber": "<string>",
    "EmiratesId": "<string>",
    "Nationality": "<string>",
    "ResidentialAddress": {
      "AddressLine": [
        "<string>"
      ],
      "Locality": "<string>",
      "Region": "<string>",
      "PostalCode": {
        "PostalCode": "<string>"
      },
      "Country": {
        "CountryCode": "<string>"
      }
    },
    "LeadInformation": "<string>",
    "ProductCategories": [
      {}
    ]
  }
}

Authorizations

Authorization · string · header · required

TPP confidential client authorization with the LFI to stage a consent. Please refer to OpenID FAPI Security Profile 1.0 -Part 2 Advanced - 5.2.2 point 14 - shall authenticate the confidential client using one of the following methods private_key_jwt and OpenID Connect Core 1.0 9. Client Authentication private_key_jwt

Headers

authorization · string · required

An authorization Token as per https://tools.ietf.org/html/rfc6750

Body

application/json

Request Body

The request to create a lead.

Data · object · required

The data for the lead request.

Show child attributes

Response

201

application/json

Lead Response

Data · object · required

The data for the lead response.

Show child attributes