CreateNewLEI - gogetssl/api GitHub Wiki

Create new LEI

URL: /orders/lei/create?auth_key={{V1_API_TOKEN}}

Content-Type: application/x-www-form-urlencoded

Request type: POST

OVERVIEW

Placing an order for LEI products

REQUEST PARAMETERS

• productId - Required. Product ID, can be taken from getAllProducts method.
• legalName - Required.String. Name of the Legal Entity noting that accuracy here helps the overall process flow and accuracy of any potential duplicate test. e.g. ABC Limited
• registrationAuthorityEntityId - Required. String. Company Number for the Legal Entity noting that accuracy here helps the overall process flow and accuracy of any potential duplicate test. e.g. 68678678 - Tip - don't forget to ensure any leading '0's are added - this is common in the UK.
• legalJurisdiction - Required. String. Format of ISO 3166-2. A supported legal jurisdiction is required. e.g. DK or US-CA for California the United States
• firstName - Required. String. The First Name(s) of the Signing Authority with the responsibility/authority to request and approve the creation of an LEI e.g. Peter
• lastName - Required. String. The Last Name of the Signing Authority e.g. Anderson
• isLevel2DataAvailable - Required. 1 or 0. A Boolean value - If the Legal Entity consolidates accounts with parental entities, then Level 2 data will be required.
• legalPostal - Required. String.
• legalfirstAddressLine - Required. String
• legalCountry - Required. String. ISO code format.
• legalCity - Required. String.
• multiYearSupport - Required. Enum - 1,2,3,4,5.

OPTIONAL PARAMETERS

• isLevel2DataConsolidate - Optional. 1 or 0.
• isLevel2DataUltimate - Optional. 1 or 0.
• incorporationDate - Optional.Date format yyyy-mm-dd.
• legalState - Optional. String.
• hqCity - Optional. String.
• hqState - Optional. String.
• hqCountry - Optional. String.
• hqfirstAddressLine - Optional. String.
• hqPostal - Optional. String.

RESPONSE

• product_id - product id
• order_number - unique order UIID
• order_id - unique order ID
• lei_id - unique lei ID
• order_amount - order amount
• currency - order currency
• tax - order tax if applicable
• tax_rate - order tax rate if applicable
• success - success code (true)
• invoice_num - unique invoice UIID (Optional)
• invoice_id - unique invoice ID (Optional)]

Example code

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{{V1_URL_PREFIX}}/orders/lei/create?auth_key={{V1_API_TOKEN}}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => false,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "productId=163&legalName=SIA%20TEST&registrationAuthorityEntityId=test-id&legalJurisdiction=LV&firstName=Name&lastName=Wang&isLevel2DataAvailable=1&incorporationDate=2020-02-13&legalState=Latgale&legalPostal=lv-1010&legalfirstAddressLine=Brivibas%2013&legalCountry=lv&legalCity=Riga&multiYearSupport=1",
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/x-www-form-urlencoded"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
} ?>

Example response

{
    "product_id": "163",
    "order_number": "L1316726",
    "order_id": "1316726",
    "invoice_num": "GGS-0220845193",
    "invoice_id": "908041",
    "lei_id": "137",
    "order_amount": 201.67,
    "currency": "EUR",
    "tax": "37.71",
    "tax_rate": "23%",
    "success": true
}