Verify a firm

Verify the firm's customs account (API-driven; one attempt per call)

curl --request POST \
  --url https://api.scripxhq.com/v1/firms/{iec}/verify \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "registration_id": "<string>",
  "password": "<string>"
}
'

import requests

url = "https://api.scripxhq.com/v1/firms/{iec}/verify"

payload = {
    "registration_id": "<string>",
    "password": "<string>"
}
headers = {
    "X-ScripX-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-ScripX-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({registration_id: '<string>', password: '<string>'})
};

fetch('https://api.scripxhq.com/v1/firms/{iec}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripxhq.com/v1/firms/{iec}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'registration_id' => '<string>',
    'password' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ScripX-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/firms/{iec}/verify"

	payload := strings.NewReader("{\n  \"registration_id\": \"<string>\",\n  \"password\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ScripX-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripxhq.com/v1/firms/{iec}/verify")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"registration_id\": \"<string>\",\n  \"password\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/firms/{iec}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"registration_id\": \"<string>\",\n  \"password\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "firm": {
    "iec": "<string>",
    "name": "<string>",
    "email": "<string>",
    "created_at": "<string>"
  },
  "authorization": {
    "sent_to": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

POST

firms

{iec}

verify

Verify the firm's customs account (API-driven; one attempt per call)

curl --request POST \
  --url https://api.scripxhq.com/v1/firms/{iec}/verify \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "registration_id": "<string>",
  "password": "<string>"
}
'

import requests

url = "https://api.scripxhq.com/v1/firms/{iec}/verify"

payload = {
    "registration_id": "<string>",
    "password": "<string>"
}
headers = {
    "X-ScripX-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-ScripX-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({registration_id: '<string>', password: '<string>'})
};

fetch('https://api.scripxhq.com/v1/firms/{iec}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripxhq.com/v1/firms/{iec}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'registration_id' => '<string>',
    'password' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ScripX-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/firms/{iec}/verify"

	payload := strings.NewReader("{\n  \"registration_id\": \"<string>\",\n  \"password\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ScripX-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripxhq.com/v1/firms/{iec}/verify")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"registration_id\": \"<string>\",\n  \"password\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/firms/{iec}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"registration_id\": \"<string>\",\n  \"password\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "firm": {
    "iec": "<string>",
    "name": "<string>",
    "email": "<string>",
    "created_at": "<string>"
  },
  "authorization": {
    "sent_to": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

Verifies the firm’s customs account. Your platform collects the firm’s credentials in its own UI under the firm’s explicit mandate (see API terms) and submits them here; ScripX runs the verification and returns only the outcome. One verification attempt per call, deliberately: verification attempts are strictly rate-limited, so batch retries buy nothing. The password is handed straight through for the attempt; it is never stored and never echoed, on our side or in any response. Two outcomes:

connected, done in one step.
verification_pending with next: "authorize", a one-time authorization code went to the firm’s registered email and mobile; finish with authorize.

Request example

curl -X POST "https://api.scripxhq.com/v1/firms/0512345678/verify" \
  -H "X-ScripX-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"registration_id": "acmexports", "password": "<FIRM_SUPPLIED>"}'

Response example

{
  "firm": {
    "iec": "0512345678",
    "name": "Acme Exports Pvt Ltd",
    "state": "verification_pending"
  },
  "next": "authorize",
  "authorization": {
    "sent_to": "the firm's registered email and mobile"
  }
}

In sandbox the flow simulates end to end: verify always returns verification_pending, and any 6-digit code completes it. Same shapes as production, no real account touched.

Errors

422 unprocessable, missing registration_id or password.
404 not_found, the firm is not registered on your desk (register first).
Wrong credentials surface as an error message; the state does not advance. Never loop retries, ask the firm to re-enter.

Terms used here: IEC, connection state, batch, API key. Full list in the terminology annexure.

Next steps

Authorize with the code the firm received.
Get the firm any time for the current state.

Authorizations

X-ScripX-Key

string

header

required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Path Parameters

iec

string

required

Body

application/json

Submit only under the firm's explicit mandate. One verification attempt per call.

registration_id

string

required

the firm's customs-account id

password

string<password>

required

handed straight through for verification; never stored, never echoed

Response

firm

object

Show child attributes

enum<string> | null

authorize → finish with POST /v1/firms/{iec}/authorize

Available options:

authorize,

null

authorization

object

Show child attributes

⌘I

Overview

Firms

Scrips & credits

Quotes & orders

Positions

Cross desk

Market & rates

Statements, earnings & usage

Settings

API keys

Webhooks

Audit

Request example

Response example

Errors

Next steps

Authorizations

Path Parameters

Body

Response

​Request example

​Response example

​Errors

​Next steps

Authorizations

Path Parameters

Body

Response

Request example

Response example

Errors

Next steps