# German Non-Ltd Company Reports

The Non-Ltd Company Search and Report provides a set of endpoints to:

- Authenticate
- Acquire the Search Criteria for a search
- Search for the company
- Retrieve detailed Non-Ltd company reports


Below is a flow diagram that outlines how to use these endpoints effectively.

## Flow Diagram


```mermaid
graph TD
    A(Authenticate) --> B(Search Criteria)
    B --> C(Company Search)
    C --> D(Company Report)
```

## 1. Authenticate

Before using any of the endpoints, you must authenticate. This ensures you have the necessary permissions to access the data.

### Example Request


```http
POST /authenticate
```

## 2. Search Criteria Endpoint

The Search Criteria endpoint allows you to retrieve parameters that you can use to search for a company. This is the first step in narrowing down your search.

### Example Request


```http
GET companies/searchCriteria?countries=us
```

### Example Response


```json
{
  "criteriaSets": [
    {
      "name": {
        "required": true,
        "minLength": 0
      },
      "telephone": {
        "countryAreaCode": {
          "required": true
        },
        "number": {
          "required": true
        },
        "areaCode": {
          "required": true
        }
      },
      "address": {
        "postCodePoBox": {
          "required": true,
          "minLength": 0
        },
        "country": {
          "required": true,
          "minLength": 0
        },
        "poBox": {
          "required": true,
          "minLength": 0
        },
        "postCode": {
          "required": true,
          "minLength": 0
        },
        "city": {
          "required": true
        },
        "street": {
          "required": true
        }
      }
    }
  ],
  "languages": [
    "string"
  ],
  "country": [
    "string"
  ]
}
```

## 3. Company Search

The Company Search endpoint allows you to search for non-limited companies in Germany. You must provide at least the `name` and `city` as query parameters. Additional parameters can be used to narrow the search, increasing the likelihood of obtaining a single match, which is required for further processing.

### Endpoint


```http
GET /localSolutions/DE/nonLtdCompanies
```

### Required Query Parameters

| Parameter | Type | Description |
|  --- | --- | --- |
| `name` | string | The name of the company you are searching for. |
| `city` | string | The city where the company is located. |


### Example Request


```http
GET /localSolutions/DE/nonLtdCompanies?name=ExampleCompany&city=Berlin
```

### Example Response


```json
{
  "matches": [
    {
      "id": 12345,
      "country": "DE",
      "name": "ExampleCompany",
      "address": {
        "simpleValue": "Example Street 1, 10115 Berlin",
        "street": "Example Street 1",
        "city": "Berlin",
        "postCode": "10115"
      },
      "status": "Active",
      "type": "Non-Ltd",
      "matchScore": 95
    }
  ]
}
```

### Notes

- The more parameters you include in your search, the higher the likelihood of obtaining a single match.
- If multiple matches are returned, refine your search criteria to narrow the results.


## 4. Company Report

The Company Report endpoint retrieves a detailed report for a specific non-limited company in Germany. You must provide the `id` of the company in the path and a `reason` in the query.

### Endpoint


```http
GET /localSolutions/DE/nonLtdCompanies/{id}
```

### Required Parameters

| Parameter | Type | Location | Description |
|  --- | --- | --- | --- |
| `id` | string | Path | The unique identifier of the company obtained from the Company Search. |
| `reason` | number | Query | The reason code for requesting the report. See the table below for options. |


### Reason Codes

| Code | Description |
|  --- | --- |
| 1 | Credit enquiry |
| 2 | Credit Decision |
| 3 | Credit Assessment - Future business connection (with credit risk) |
| 4 | Credit Assessment - Existing business connection (with credit risk) |
| 5 | Realisation check receivables collection |
| 6 | Purchase Contract - Intention of signature of purchase contract (with credit risk) |
| 7 | Contract - Intention of signature of leasing or rent contract (with credit risk) |
| 8 | Insurance Contract - Intention of signature of an insurance contract (with credit risk) |


### Example Request


```http
GET /localSolutions/DE/nonLtdCompanies/12345?reason=1
```

### Response

The response contains detailed information about the company. Due to the complexity of the response, it is recommended to refer to the API documentation for the full response structure.

### Notes

- Ensure that the `id` is obtained from a successful Company Search.
- The `reason` parameter must be a valid code from the table above.