Public: a carrier asks for an account, proves its email with a code, and waits for the shipping.nc staff to accept it.
Ask for a carrier account
Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). Checks the RIDET against the register, then emails a 6-digit code that proves the address. The answer never tells whether the email already has an account.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Ask for a carrier account › Request Body
ridetThe establishment, as the RIDET register knows it. The name and legal form come from the register.
communeWhere the deliveries start; the commune of the register unless the carrier chose another one.
first_namelast_nameemail^(?:[A-Za-z0-9_'+\-]… · requiredWhere the verification code, then the invitation, are sent.
localeThe language of the emails.
accept_termsThe terms of use and the privacy policy are accepted.
phoneA phone number. Six digits without a prefix are read as a New Caledonia number (+687).
Ask for a carrier account › Responses
The code was sent.
idemailcode_expires_at^(?:(?:\d\d[2468][04… · requiredWhen the code just sent stops working.
resend_available_at^(?:(?:\d\d[2468][04… · requiredWhen a new code may be asked for.
Verify the email of a signup request
Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). A code works for 15 minutes and 5 attempts; a 422 tells which in details.reason (wrong, expired, locked) and details.attempts_left. Once verified, the request waits for the shipping.nc staff.
path Parameters
idThe id the creation answered.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Verify the email of a signup request › Request Body
codeThe 6-digit code of the email; spaces are ignored.
Verify the email of a signup request › Responses
The request waits for review.
idcompany_nameridetcommunefirst_nameemailSend a new verification code
Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). At most one code a minute per request and 5 a day per email; a 429 carries Retry-After and details.reason (cooldown, daily_limit). The previous code stops working.
path Parameters
idThe id the creation answered.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Send a new verification code › Responses
A new code was sent.
idemailcode_expires_at^(?:(?:\d\d[2468][04… · requiredWhen the code just sent stops working.
resend_available_at^(?:(?:\d\d[2468][04… · requiredWhen a new code may be asked for.
Search the company register
Up to 10 establishments by name, trade name or acronym, or by the start of a RID or RIDET. From the ISEE register of active establishments (RIDET), published on data.gouv.nc under the Licence Ouverte v2.0. The register is refreshed monthly and lists no street address. A 503 means the register is unavailable: type the company in. Fills the company of a signup request. Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). Answers may be cached for five minutes.
query Parameters
qA company name, trade name or acronym, or the start of a RID or RIDET.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Search the company register › Responses
The matching establishments.
Get an establishment of the company register
From the ISEE register of active establishments (RIDET), published on data.gouv.nc under the Licence Ouverte v2.0. The register is refreshed monthly and lists no street address. A 503 means the register is unavailable: type the company in. Fills the company of a signup request. Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). Answers may be cached for five minutes.
path Parameters
ridetThe RIDET: 7 figures, a dot and the 3-figure establishment rank.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get an establishment of the company register › Responses
The establishment.
ridet^\d{7}\.\d{3}$ · requiredThe business identifier in New Caledonia.
legal_nameThe registered name.
trade_nameThe sign of the establishment.
acronymlegal_formlegal_form_labelThe legal form as the register names it.
activityThe NAF activity of the establishment.
communeNull when the establishment is outside New Caledonia.
province