Company

The following endpoints allow you to view and manage the company information attached to the specified merchant/domain.

Get company

get

Retrieves information about the current company

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

The company information

application/json

get

/portal/instance/company

GET /api/portal/instance/company HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The company information

{
  "result": {
    "id": "text",
    "name": "text",
    "email": "[email protected]",
    "primary_color": "#c3c3c3",
    "country_id": "US",
    "state_id": "DE",
    "industry_id": 2,
    "sector_id": 1,
    "criterias": [
      1
    ],
    "vat_number": "text",
    "registration_number": "text",
    "logo_url": "https://example.com",
    "logo_light_url": "https://example.com",
    "default_language": {
      "id": "text",
      "code": "EN",
      "name": "English"
    },
    "contact_information": {
      "email": "[email protected]",
      "phone_number": 40741222333,
      "fax_number": 40741222333
    },
    "offices": [
      {
        "is_main": true,
        "id": 1,
        "name": "text",
        "address": {
          "id": "text",
          "country": "RO",
          "state": "text",
          "address": "text",
          "address_2": "text",
          "postal_code": "text",
          "phone_number": 40755111222
        }
      }
    ],
    "representatives": [
      {
        "id": "text",
        "type": "PERSON",
        "email": "[email protected]",
        "company_name": "text",
        "first_name": "text",
        "last_name": "text",
        "position": "text",
        "description": "text",
        "avatar_url": "https://example.com",
        "category": "text",
        "jurisdiction": [
          "text"
        ],
        "address": {
          "id": "text",
          "country": "RO",
          "state": "text",
          "address": "text",
          "address_2": "text",
          "postal_code": "text",
          "phone_number": 40755111222
        },
        "created_at": "2026-02-03T09:48:30.774Z"
      }
    ],
    "bank_accounts": [
      {
        "id": 1,
        "name": "text",
        "account_number": "text"
      }
    ]
  }
}

Update company

put

Change company information and settings

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Body

namestringOptional

The new company name

emailstring · emailOptional

The new company email

langstringOptional

The new default language for the company

Example: RO

vat_numberstringOptional

The new company VAT number

registration_numberstringOptional

The new company registration number

primary_colorstringOptional

The hex-encoded color to be applied for this company

Example: #c3c3c3

country_idstringOptional

The ISO-3166 Alpha-2 country code for this company, available via the /company/countries API call

Example: US

state_idstringOptional

The state code for the company, if applied, available via the /company/countries API call

Example: DE

industry_idnumberOptional

The company's industry, available via the /company/industries API call

Example: 2

sector_idnumberOptional

The company's sector, available via the /company/sectors API call

criteriasnumber[]Optional

The company's custom criteria groups, available via the /company/criteria-groups API call

logo_urlstringOptional

A previously-uploaded image id that will act as the company's logo image on dark background

Example: 155e178a582341ffba1a57f66on1col4.3d07ab5....

logo_light_urlstringOptional

A previously-uploaded image id that will act as the company's logo image on light background

Example: 155e178a582341ffba1a57f66on1col4.3d07ab5....

Responses

200

Company information updated

application/json

Responseobject

put

/portal/instance/company

PUT /api/portal/instance/company HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 683

{
  "name": "text",
  "email": "[email protected]",
  "lang": "RO",
  "vat_number": "text",
  "registration_number": "text",
  "primary_color": "#c3c3c3",
  "country_id": "US",
  "state_id": "DE",
  "industry_id": 2,
  "sector_id": 1,
  "criterias": [
    1
  ],
  "logo_url": "155e178a582341ffba1a57f66on1col4.3d07ab5....",
  "logo_light_url": "155e178a582341ffba1a57f66on1col4.3d07ab5....",
  "offices": [
    {
      "is_main": true,
      "id": 1,
      "name": "text",
      "address": {
        "id": "text",
        "country": "RO",
        "state": "text",
        "address": "text",
        "address_2": "text",
        "postal_code": "text",
        "phone_number": 40755111222
      }
    }
  ],
  "bank_accounts": [
    {
      "id": 1,
      "name": "text",
      "account_number": "text"
    }
  ],
  "contact_information": {
    "email": "[email protected]",
    "phone_number": 40741222333,
    "fax_number": 40741222333
  }
}

200

Company information updated

{}

Prepare upload

post

This API endpoint is used when you want to upload a logo image to the company. This will generate a signed upload URL you can use.

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Body

typestring · enumRequired

The type of asset you want to prepare the upload for

Possible values:

mimestringRequired

The mime type of the image you want to upload

Example: image/png

Responses

200

Result with an upload URL you can use

application/json

post

/portal/instance/company/sign-asset

POST /api/portal/instance/company/sign-asset HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "type": "logo_light",
  "mime": "image/png"
}

200

Result with an upload URL you can use

{
  "result": {
    "url": "https://eu1.clym.io/api/u/CPK6....."
  }
}

Delete asset

delete

This API endpoint is used when you want to remove a previously uploaded asset from the company.

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Path parameters

typestring · enumRequiredPossible values:

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

Request completed successfully

application/json

delete

/portal/instance/company/image/{type}

DELETE /api/portal/instance/company/image/{type} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Request completed successfully

{
  "result": {}
}

Create representative

post

Create a new company-level representative

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Body

The representative form

typestring · enumRequired

The type of representative to configure

Possible values:

categorystring · enumRequired

The representative category

Possible values:

company_namestringOptional

The company name if the representative is an organization

first_namestringOptional

The person's first name if the representative is a person

last_namestringOptional

The person's last name if the representative is a person

positionstringOptional

The representative's position within the company

descriptionstringOptional

A short representative description

emailstring · emailRequired

The representative's email address

countrystringOptional

The representative's 2-letter country code

statestringOptional

The representative's state

citystringOptional

The representative's city

addressstringOptional

The representative's address

address_2stringOptional

The representative's address 2

postal_codestringOptional

The representative's postal code

phone_numberstringOptional

The representative's phone number

avatar_urlstringOptional

A previously signed and uploaded asset id

Responses

200

Result with the representative information

application/json

post

/portal/instance/company/representatives

POST /api/portal/instance/company/representatives HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 326

{
  "type": "PERSON",
  "category": "DPO",
  "company_name": "text",
  "first_name": "text",
  "last_name": "text",
  "position": "text",
  "description": "text",
  "email": "[email protected]",
  "jurisdiction": [
    "UK"
  ],
  "country": "text",
  "state": "text",
  "city": "text",
  "address": "text",
  "address_2": "text",
  "postal_code": "text",
  "phone_number": "text",
  "avatar_url": "text"
}

200

Result with the representative information

{
  "result": {
    "id": "text",
    "type": "PERSON",
    "email": "[email protected]",
    "company_name": "text",
    "first_name": "text",
    "last_name": "text",
    "position": "text",
    "description": "text",
    "avatar_url": "https://example.com",
    "category": "text",
    "jurisdiction": [
      "text"
    ],
    "address": {
      "id": "text",
      "country": "RO",
      "state": "text",
      "address": "text",
      "address_2": "text",
      "postal_code": "text",
      "phone_number": 40755111222
    },
    "created_at": "2026-02-03T09:48:30.774Z"
  }
}

Update representative

put

Update a previously created company-level representative

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Path parameters

idstringRequired

The representative id

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Body

The representative form

typestring · enumOptional

The type of representative to configure

Possible values:

categorystring · enumOptional

The representative category

Possible values:

company_namestringOptional

The company name if the representative is an organization

first_namestringOptional

The person's first name if the representative is a person

last_namestringOptional

The person's last name if the representative is a person

positionstringOptional

The representative's position within the company

descriptionstringOptional

A short representative description

emailstring · emailOptional

The representative's email address

countrystringOptional

The representative's 2-letter country code

statestringOptional

The representative's state

citystringOptional

The representative's city

addressstringOptional

The representative's address

address_2stringOptional

The representative's address 2

postal_codestringOptional

The representative's postal code

phone_numberstringOptional

The representative's phone number

avatar_urlstringOptional

A previously signed and uploaded asset id

Responses

200

Result with the DPO information

application/json

put

/portal/instance/company/representatives/{id}

PUT /api/portal/instance/company/representatives/{id} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 326

{
  "type": "PERSON",
  "category": "DPO",
  "company_name": "text",
  "first_name": "text",
  "last_name": "text",
  "position": "text",
  "description": "text",
  "email": "[email protected]",
  "jurisdiction": [
    "UK"
  ],
  "country": "text",
  "state": "text",
  "city": "text",
  "address": "text",
  "address_2": "text",
  "postal_code": "text",
  "phone_number": "text",
  "avatar_url": "text"
}

200

Result with the DPO information

{
  "result": {
    "id": "text",
    "type": "PERSON",
    "email": "[email protected]",
    "company_name": "text",
    "first_name": "text",
    "last_name": "text",
    "position": "text",
    "description": "text",
    "avatar_url": "https://example.com",
    "category": "text",
    "jurisdiction": [
      "text"
    ],
    "address": {
      "id": "text",
      "country": "RO",
      "state": "text",
      "address": "text",
      "address_2": "text",
      "postal_code": "text",
      "phone_number": 40755111222
    },
    "created_at": "2026-02-03T09:48:30.774Z"
  }
}

Delete representative

delete

Deletes a previously created company-level representative

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Path parameters

idstringRequired

The representative id

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

Result with the DPO information

application/json

delete

/portal/instance/company/representatives/{id}

DELETE /api/portal/instance/company/representatives/{id} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Result with the DPO information

{
  "result": {
    "deleted": true
  }
}

Prepare upload

post

This API endpoint is used when you want to upload a profile image to the representative. This will generate a signed upload URL you can use.

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Body

mimestringRequired

The mime type of the image you want to upload

Example: image/png

Responses

200

Result with an upload URL you can use

application/json

post

/portal/instance/company/representatives/sign-asset

POST /api/portal/instance/company/representatives/sign-asset HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "mime": "image/png"
}

200

Result with an upload URL you can use

{
  "result": {
    "url": "https://eu1.clym.io/api/u/CPK6....."
  }
}

PreviousData NextRecords

Last updated 6 months ago

hashtagGet company

hashtagUpdate company

hashtagPrepare upload

hashtagDelete asset

hashtagCreate representative

hashtagUpdate representative

hashtagDelete representative

hashtagPrepare upload

Get company

Update company

Prepare upload

Delete asset

Create representative

Update representative

Delete representative

Prepare upload