Last Updated: 20th September 2024

Validate Entity

POST

/taxpayer/validate

LHDN

This endpoint allows source systems to perform validation of TIN and NRIC with LHDN.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

idType

string

optional

ENUM: NRIC, Passport, BRN, Army

Example:

BRN

idNum

string

optional

Alphanumeric with no spaces, no dashes, no symbols

Example:

200101023695

tin

string

optional

TIN Number only

Example:

C20494188010

Header Params

string

optional

Example:

application/json

Body Params application/json

array of:

id_type

string

required

"BRN" or "NRIC"

id_number

string

required

The Identity Number (BRN or NRIC)

tin

string

required

Tax Identification Number to validate

Example

[
  {
    "id_type": "BRN",
    "id_number": "197201001581",
    "tin": "C865879100"
  },
  {
    "id_type": "BRN",
    "id_number": "197201001581",
    "tin": "C86587910"
  },
  {
    "id_type": "BRN",
    "id_number": "EI00000000030",
    "tin": "C4865297000"
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://einvoice-api.beaconx.com.my/taxpayer/validate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '[
    {"id_type": "BRN", "id_number": "197201001581", "tin": "C865879100"},
    {"id_type": "BRN", "id_number": "197201001581", "tin": "C86587910"},
    {"id_type": "BRN", "id_number": "EI00000000030", "tin": "C4865297000"}
]'

Responses

🟢200OK

application/json

Body

status

string

required

Returns "OK" when API is functional

message

string

required

Not used.

data

array [object {4}]

required

id_type

string

required

BRN / NRIC

id_number

string

required

tin

string

required

status

string

required

Example

{
  "status": "OK",
  "message": "",
  "data": [
    {
      "id_type": "BRN",
      "id_number": "197201001581",
      "tin": "C865879100",
      "status": "success"
    },
    {
      "id_type": "BRN",
      "id_number": "EI00000000030",
      "tin": "C4865297000",
      "status": "success"
    }
  ]
}

Modified at 2024-08-12 16:48:57

Update Reference Number

Sync Tax Payer Master List