---
title: "Update Lead"
method: PUT
path: "/{lead_id}"
---

# Update Lead

`PUT /{lead_id}`

## Path parameters

- `lead_id` string, required

## Request body

- object
  - `country` string, required — The country code in iso-2 format, the country must be the same country of the marketplace account since Tap can not split the payment across the countries.
  - `brand` object, required — The brand details of the retailer account.
    - `name` object[], required — The brand name details. At least one brand name with the lang: en is required.
      - `text` string, required — The brand name of the retailer account
      - `lang` string, required — the language en,ar.
    - `logo` string, required — The logo of the brand, it is required from the KYC team.
    - `channel_services` object[], required — At least one channel service to be added, it is required from the KYC team.
      - `channel` string, required — the channels are (website, twitter, instagram, ios, android, call_center, linkedin, physical_store)
      - `address` string, required — The reference of the channel, the marketplace can add his website as a reference.
  - `entity` object, required — The entity details of the retailer account.
    - `legal_name` object[] — The legal name of the entity, at least one entity name in en language.
      - `text` string, required — the legal name of the entity
      - `lang` string, required — The language of the text
    - `license` object, required — The license details of the entity
      - `number` string, required — The license number of the entity.
      - `unified_number` string, required — Required for the merchants in KSA.
      - `country` string, required — The country code in iso-2 format, the country must be the same country of the marketplace account since Tap can not split the payment across the countries.
      - `type` string, required — The available types (Establishment,Trust,Partnership,LLC,JSC,Foreign JSC Branch,Mix LLC,Foreign LLC,GCC Partnership,GCC LLC,GCC JSC,Foreign LLC Branch,Profession LLC,Freelancer)
      - `documents` object[] — The documents that you need to upload.
        - `name` string — commercial_registration,commercial_registration article_of_association
        - `number` string — the number in the document
        - `issuing_country` string — The country code in iso-2 format such as (SA,KW,BH,QA,AE,OM)
        - `images` string[] — Add the file ID of the uploaded file via the file API.
  - `users` object[], required — List of the users linked to the account
    - `name` object[], required — The name details of the user
      - `first` string, required — The first name of the user.
      - `middle` string, required — The middle name of the user.
      - `last` string, required — The last name of the user.
      - `lang` string, required — en,ar
    - `contact` object, required — The email and the phone number details of the user
      - `email` object[], required — The email details of the user.
        - `address` string
        - `primary` boolean
      - `phone` object[], required — The phone number of the user.
        - `country_code` string, required — The country code of the phone number without +
        - `number` string, required — the phone number.
        - `primary` boolean, required
    - `identification` object, required
      - `number` string
      - `type` string, required
      - `country` string
      - `nationality` string
    - `birth` object, required
      - `country` string
      - `city` string
      - `date` string — The date of birth in yyyy-MM-dd format. It must be matching the dob of the identification number holder
    - `primary` boolean
  - `wallet` object, required — The wallet details of the retailer account.
    - `name` object[]
      - `text` string
      - `lang` string — en,ar
    - `linked_financial_account` object, required
      - `bank` object, required
        - `account` object, required
          - `name` string
          - `iban` string, required
        - `documents` object[], required
          - `name` string
          - `issuing_country` string — The country code in iso-2 format such as (SA,KW,BH,QA,AE,OM)
          - `images` string[]
          - `number` string
          - `issuing_date` string
  - `marketplace` object, required — The object that define the marketplace details.
    - `id` string — The MID of the marketplace
  - `post` object — the webhook to receive the lead creation response
    - `url` string — the url of the webhook
  - `metadata` object — Extra object that the merchant can add more details regarding the account, (for the merchant references only)

## Response `200`

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/tap/apis/authorize.md) · [All operations](https://skmtc.net/tap/apis/authorize/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tap/authorize/versions/86f4d9b29db0/schema)