Submit License
POST/gds/vendor/properties/:vendor_property_id/licenses
- Submits a property's license document (
permit) or business registration certificate (business). Send one request per document, and set the document type withtype. permitis a license document, such as a business report certificate, tourism business registration, or rural homestay registration. Put the license type code indata.type.- Send the document fields and the file together in
data. The file is a base64-encoded string; file names are not accepted. - Supported formats are jpeg, png, gif, webp, and pdf, detected from the file content. HEIC and AVIF are not supported, and images must be at least 450 pixels wide and 200 pixels tall. Each file can be up to 10MB.
- For
business, whendata.typeiscorporation,data.name,data.address,data.industry, anddata.categoryare also required. They are optional forpersonal(sole proprietor). - A submission is accepted as
pendingand becomesconfirm(approved) orreject(rejected) after ONDA reviews it. - Resubmitting while a
pendingrequest of the same type exists changes the earlier request torejectwithSuperseded by request {new request ID}inreason. If the new request is rejected with400or422, the earlier request stays as it is. - Both
permitandbusinessmust be approved (confirm) before a Plus channel can be opened. Only the most recently approved document per type is active, and the previously approved document stays current until a new one is approved.
Request
Responsesapplication/json
- 200
- 400
- 401
- 404
- 413
- 422
Returns the accepted submission request.
Bad Request. Returned when a required field is missing or a value is malformed: an unsupported type, a data.type not in the code list, a business registration number with an invalid length or checksum, a future date, or a file that cannot be read as base64. For a corporation, 400 is also returned if any of data.name (business name), data.address (business address), data.industry (industry), or data.category (business category) is missing.
Unauthorized
Not Found. Returned when vendor_property_id is not a property linked to this vendor.
Payload Too Large. Returned when the request body is too large.
Unprocessable Entity. Returns Unsupported file format for unsupported formats (HEIC, AVIF, etc.), Image must be at least 450x200 pixels for images smaller than 450x200 pixels, and Image conversion failed when the image cannot be converted to JPG.