Read the firm card

You use this method to read the firm cards.

Request method


Request url{DossierId}/Firm[?fields={FieldList}]

Context identification

Identification Description
DossierId The unique identifier of the dossier.


Parameter Description
Fields List of fields, containing property names of the firm card, of which the value has to be returned in the response body. (optional)
Example: From dossier 'Demo' get the firm card and limit the data to the following fields: 'VatNum', 'BankAccount1' and 'SwiftCode1'.,BankAccount1,SwiftCode1

Request header

See request header.

Request body


Http status

See http status.

Response body

You can receive the response in json or xml.


Response (object)


  "Response": {
    "Firm": {
      "Fields" : {
        "VatNum": "BE 0427.604.308",
        "BankAccount1": "IBAN BE89 2900 2123 9785",
        "SwiftCode1": "GEBABEBB"
<?xml version="1.0" encoding="utf-8"?>
      <VatNum>BE 0427.604.308</VatNum>
      <BankAccount1>IBAN BE89 2900 2123 9785</BankAccount1>