Company's Management

The API creates a company if all the mandatory fields are provided (see company's resource).

By default, the company is considered 'ACTIVE' if the Status field is not provided.

The default address of the company must be also configured.

The API returns a customer reference (as company).

The response can also be enriched (if specified as embedded fields in input) with additional data such as company information, address identifiers linked to the company, addresses of the company, contacts of the company.

API links

The "retrieve company's information" API allows the user to get company information.

Information to be provided in input:

• The issuer ID
• The customer reference or the issuer customer reference (as company)

In addition to the company information, it is also possible to request the list of addresses and contacts of the company.

API links

The "update company" API allows the user to update the attributes of a customer (as company).

To identify the company, it is needed to provide:

• The issuer ID
• The customer reference or the issuer customer reference (as company) for which updates are required

The customer reference can be retrieved by using the "Retrieve list of company's information" API.

All the attributes must be given in input even if they remain unchanged. For that, It can be needed to use the "retrieve company's information" API to get all the current attributes.

API links

The "update company partially" API allows the user to update the attributes of a customer (as company).

To identify the company, it is needed to provide:

• The issuer ID
• The customer reference or the issuer customer reference (as company) for which updates are required

The customer reference can be retrieved by using the "Retrieve list of company's information" API.

With this API, only attributes that need to be updated must be given in input.

API links

The "Retrieve list of company's information" API enables to get a list of customers based on multiple criteria such as corporateName, nationalFiscalNumber, address town name, address postal code.

All companies whose corporate name includes the 'corporate name' parameter are returned (e.g. 'zon' => 'amazon' + 'zon craft', ...)

API links

This API enables all the addresses associated with a given customer (as company), identified by customer reference or issuer customer reference to be retrieved.

To identify the company, it is needed to provide:

• The issuer ID
• The customer reference or the issuer customer reference (as company)

The address could be either a permanent address or a temporary address.

Several address types are managed. Each address can be used for a specific usage (card delivery, statement delivery, contract letter,...).

Address usage is associated to a service (card service, account service, dispute service, ..) configured in our system.

The API can retrieve only the addresses linked to a specific usage: in this case, all the mandatory 'AddressUsage' attributes must be provided (e.g. serviceCode, AddressUsage).

If the showHistory indicator is set to Y then the full history of the addresses and the future addresses are returned. If this indicator is empty (default behavior) or equals to N, then only the last active addresses are returned.

Address identifiers, Address attributes and Address usages are displayed in the response.

API links

This API enables all the contracts belonging to a given company to be retrieved.

Information to be provided in input:

• The issuer ID
• The customer reference or the issuer customer reference (as company)

The API response contains a list of contracts with related information.

API links

The API creates a contact person belonging to the company by providing information such as first name, name, department to which he is attached.

To create a contact, it is needed to provide:

• The issuer ID
• The customer reference or the issuer customer reference (as company)

API links

The API allows information of a contact of the company to be modified.

To update a contact, it is needed to provide:

• The issuer ID
• The customer reference or the issuer customer reference (as company)
• The contact reference

All attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty.

API links

The API allows a contact of the company to be deleted.

To remove a contact, it is needed to provide:

• The issuer ID
• The customer reference or the issuer customer reference (as company)
• The contact reference

API links

The API allows the company update history of a company to be retrieved.

The main input fields requested by the API are:

• The issuer ID
• The customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference (as company).

A start date and an end date can be provided in order to limit the search of the history.

In response, the interface provides a list of changes with the effective date of the update.

API Links