Back to neotek ↗Get Sandbox Access

GetBasicDetails

POSThttps://test.api.neotek.sa/establishment-information/v1/get-basic-details

Sandbox URL · in Production call https://api.neotek.sa

The establishment's identity, registration status and economic activity classification.

BodyData is required, and must carry one of the two identifiers:

ParameterRequiredDescription
Data.CRNumberConditionalthe commercial registration number. Required if SevenHundredNumber is absent
Data.SevenHundredNumberConditionalthe 700-series unified number. Required if CRNumber is absent

Headers:

ParameterRequiredDescription
authorizationRequiredBearer <ACCESS_TOKEN>, with scope establishment_information
content-typeRequiredapplication/json. Absent from the specification's header table, but omitting it returns 415
acceptOptionalreturns 406 if present and mismatched
x-request-idOptionalan RFC 4122 UUID you generate; recommended for tracing
accept-languageOptionalbackend-dependent; the likely control over which language the text fields come back in
sub-clientOptionalidentifies the downstream consumer when one client fronts several
cURL
curl -X POST 'https://test.api.neotek.sa/establishment-information/v1/get-basic-details' \  --header 'authorization: Bearer <ACCESS_TOKEN>' \  --header 'content-type: application/json' \  --data '{    "Data": {      "SevenHundredNumber": "7001234568"    }  }'

Response

JSON
{  "Data": {    "Name": "شركة الأمثلة للمقاولات",    "Type": "شركة",    "Size": "عملاقة",    "Status": "قائمة",    "EstablishmentEconomicActivity": "مقاولات التشييد والبناء والنظافة",    "EstablishmentEconomicActivityCode": 450,    "ISICActivity": "التنظيف العام للمباني",    "ISICActivitycode": 537,    "CertificateStartDate": "2015-01-01 00:00:00.000",    "CertificateEndDate": "2026-12-31 00:00:00.000",    "LegalRegistration": "ذات مسؤولية محدودة",    "CRNumber": 1010001234,    "SevenHundredNumber": 7001234567,    "CRStatus": "Active",    "LaborOfficeId": 6,    "ClosingDate": "2027-01-01"  }}

Errors

CodeStatusCause and Action
400Bad RequestMissing required field, or a value that fails validation — check Code and Path in the body
401UnauthorizedBearer token missing, expired, or invalid
403ForbiddenToken doesn't carry the establishment_information scope
404Not FoundNo resource matches the identifier provided
405Method Not AllowedHTTP verb not supported on that path
406Not AcceptableAccept header doesn't match a supported representation
415Unsupported Media TypeContent-Type missing or wrong
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer error — retry with backoff, quote your x-request-id