Create Company Document

Request

Upload a document for a specific company.

Security

oAuth2ClientCredentials

Path

company_idstring, (uuid)(Company Id)required

Bodyapplication/jsonrequired

upload_idstring, (uuid)(Upload Id)required

Unique identifier of the uploaded file

document_typeCustomerDocumentTypeInput (string) or SubcontractorDocumentWithoutValidityTypeInput (string) or SubcontractorDocumentWithValidityTypeInput (string) or SubcontractorInsuranceDocumentTypeInput (string)(Document Type)required

Any of:

Type of the document

string(CustomerDocumentTypeInput)

Enum:"AUTHORIZATION_PREFERENTIAL_ORIGIN""BANK_DETAILS""CMR_INSURANCE""COMMUNICATION""COMPANY_TDS""CREDIT_REPORT""DGSA_CERTIFICATE""ECMT_TRANSPORT_LICENSE""EU_TRANSPORT_LICENSE""FREIGHT_FORWARDER_LICENSE"

namestring(Name)required

Name of the document

validityCompanyValidity (object) or null

Any of:

Validity information associated with the uploaded document.

POST

/v1/companies/company/{company_id}/documents

{
  "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  "document_type": "AUTHORIZATION_PREFERENTIAL_ORIGIN",
  "name": "string",
  "validity": {
    "start_time": "2019-08-24T14:15:22Z",
    "end_time": "2019-08-24T14:15:22Z",
    "legal_end_time": "2019-08-24T14:15:22Z",
    "generate_unavailability": false,
    "type": "ATA_CARNET",
    "external_id": "string",
    "description": "string"
  }
}

Responses

Successful Response

Bodyapplication/json

idstring, (uuid)(Id)required

Unique identifier of the document

namestring(Name)required

Name of the document

typeSubcontractorDocumentWithValidityTypeInput (string) or SubcontractorInsuranceDocumentTypeInput (string) or CustomerDocumentTypeInput (string) or SubcontractorDocumentWithoutValidityTypeInput (string)(Type)required

Any of:

Type of the document.

string(SubcontractorDocumentWithValidityTypeInput)

Enum:"ATA_CARNET""BANK_DETAILS""CMR_INSURANCE""COMMON_HEALTH_ENTRY_DOCUMENT""COMMUNICATION""COMMUNICATION_SUBCONTRACTOR""SUBCONTRACTOR_CONTRACT""CREDIT_REPORT""DGSA_CERTIFICATE""ECMT_TRANSPORT_LICENSE"

download_urlstring(Download Url)

Relative URL from the base URL to download the document

Default:""

subject_typestring(Subject Type)required

Linked subject of the document

content_typestring or null(Content Type)

Any of:

Content type of the document

string

validityCompanyValidityOutput (object) or null

Any of:

Validity information associated with the document.

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "ATA_CARNET",
  "download_url": "",
  "subject_type": "string",
  "content_type": "string",
  "validity": {
    "start_time": "2019-08-24T14:15:22Z",
    "end_time": "2019-08-24T14:15:22Z",
    "legal_end_time": "2019-08-24T14:15:22Z",
    "generate_unavailability": false,
    "type": "ATA_CARNET",
    "external_id": "string",
    "description": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}