API changes: new country parameter in landing_company_details

deriv_api_support · April 2023

Dear developers,
We’re adding an optional country parameter to the landing_company_details API. This will be released in the week starting April 24.

API request before the change:

{
  "landing_company_details": "bvi"
}

API request after the change:

{
  "landing_company_details": "bvi",
  "country": "id"
}

API response before the change:

{
  "echo_req": {
    "country": "id",
    "landing_company_details": "bvi"
  },
  "landing_company_details": {
    "address": [
      "Kingston Chambers",
      "PO Box 173",
      "Road Town",
      "Tortola",
      "British Virgin Islands"
    ],
    "changeable_fields": {},
    "country": "British Virgin Islands",
    "currency_config": {},
    "has_reality_check": 0,
    "legal_allowed_contract_categories": [

    ],
    "legal_allowed_currencies": [
      "USD"
    ],
    "legal_allowed_markets": [

    ],
    "legal_default_currency": "USD",
    "name": "Deriv (BVI) Ltd",
    "requirements": {
      "after_first_deposit": {
        "financial_assessment": [
          "financial_information",
          "trading_experience"
        ]
      },
      "compliance": {
        "mt5": [
          "fully_authenticated",
          "expiration_check"
        ],
        "tax_information": [
          "tax_residence",
          "tax_identification_number"
        ]
      },
      "signup": [
        "phone",
        "citizen",
        "account_opening_reason"
      ]
    },
    "shortcode": "bvi",
    "support_professional_client": 0,
  },
  "msg_type": "landing_company_details"
}

API response after the change:
If the country parameter is provided in the API request, the response will have an additional parameter tin_not_mandatory, an integer with 2 possible values: 0 or 1.

1 = TIN is not mandatory; we don’t need to ask for the client’s TIN.
0 = TIN is mandatory; we should make the TIN field mandatory for the client to fill.

{
  "echo_req": {
    "country": "id",
    "landing_company_details": "bvi"
  },
  "landing_company_details": {
    "address": [
      "Kingston Chambers",
      "PO Box 173",
      "Road Town",
      "Tortola",
      "British Virgin Islands"
    ],
    "changeable_fields": {},
    "country": "British Virgin Islands",
    "currency_config": {},
    "has_reality_check": 0,
    "legal_allowed_contract_categories": [

    ],
    "legal_allowed_currencies": [
      "USD"
    ],
    "legal_allowed_markets": [

    ],
    "legal_default_currency": "USD",
    "name": "Deriv (BVI) Ltd",
    "requirements": {
      "after_first_deposit": {
        "financial_assessment": [
          "financial_information",
          "trading_experience"
        ]
      },
      "compliance": {
        "mt5": [
          "fully_authenticated",
          "expiration_check"
        ],
        "tax_information": [
          "tax_residence",
          "tax_identification_number"
        ]
      },
      "signup": [
        "phone",
        "citizen",
        "account_opening_reason"
      ]
    },
    "shortcode": "bvi",
    "support_professional_client": 0,
    "tin_not_mandatory": 1
  },
  "msg_type": "landing_company_details"
}

If you have any questions, write to us at api-support@deriv.com.