diff --git a/getLeiStatus.md b/getLeiStatus.md new file mode 100644 index 0000000..490d4af --- /dev/null +++ b/getLeiStatus.md @@ -0,0 +1,79 @@ +URL: /lei/status/{{order_id}}?auth_key={{Access_Token}} + +Content-Type: application/x-www-form-urlencoded + +Request type: POST + + +### Overview + +This call is used to check the LEI Order Status. Both 'LEI - Create New LEI' and 'LEI - Import Existing LEI' are supported. The Access Token from 'Authentication - Request Access Token' is required to submit the request. + +### Request parameters + +- order_id + +### Response + +If no errors in request following parameters will be returned: + +* "lei_id" - unique lei ID +* "status" - Enum: ('active','cancelled','expired','incomplete','pending','processing','rejected','revoked','unpaid','need_action') +* "product_id" - Required. Product ID, can be taken from getAllProducts method. +* "confidence_level" - Optional. +* "le_number" - LEI code +* "valid_from" - Date +* "valid_till" - Date +* "legal_address" - Optional. +* "headquarters_address" - Optiona + + +###### Example code +``` + "{{V1_URL_PREFIX}}/lei/status/{{order_id}}?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 => "GET", +)); + +$response = curl_exec($curl); +$err = curl_error($curl); + +curl_close($curl); + +if ($err) { + echo "cURL Error #:" . $err; +} else { + echo $response; +} ?> +``` + + +##### Example response + +``` +{ + "lei_id": "35", + "status": "active", + "product_id": "161", + "confidence_level": "10", + "lei_number": "98450090FE38E6Q47A33", + "valid_from": "2019-12-23 16:06:02", + "valid_till": "2020-12-23 16:06:02", + "legal_address": { + "City": "Stockport", + "Country": "GB", + "Postal": "SK8 10HG" + }, + "success": true +} +``` \ No newline at end of file