> For the complete documentation index, see [llms.txt](https://dev.ropo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ropo.com/guides/general-add-ons/onboarding/onboarding-apikey-endpoint.md).

# Onboarding - APIkey Endpoint

> Before Ropo One can send new profile's API-key, new profile's eligible person must accept Ropo One "terms & conditions" via strong authentication. When the agreement has been successfully accepted (+ KYC-process completed if applicable), API-keys will be sent automatically to your APIkey endpoint.

### Structure of APIkey Endpoint

Please provide these values to your Ropo contact person both for test and production

* URL of the endpoint
* APIkey for the endpoint

### Endpoint Structure

Example JSON:

```
{
    "bid": "1234567-8",
    "external-id": "a3029a45-2608-4c9c-a8ce-93fcbcb733a7",
    "cid": "123123",
    "apicode": "ABCDEFG123"
}
```

* bid = company Business ID
* external-id
  * external-id is an optional tag with Ropo One onboarding API. Usually external-id refers to your customer unique ID in ERP-platform. If external-id has been given with original onboarding API request, it is included automatically to help you to match the new Ropo One Profile apikey with the correct Business ID in your ERP
* cid = New profile's ID in Ropo One 
* apicode = New profile's APIcode

> When new Ropo One profile starts to use Ropo One API (like for sending invoices), cid & apikey pair is needed for API authentication

Example curl from Ropo One to your APIkey endpoint:

```
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "bid": "1234567-8", \ 
   "external-id": "a3029a45-2608-4c9c-a8ce-93fcbcb733a7", \
   "cid": "123123", \
   "apicode": "ABCDEFG123" \ 
 }' 'https://your.endpoint/xxx'
```

> Tag "external-id" is an optional tag with Ropo One onboarding API. Usually external-id refers to your customer unique ID in ERP-platform. If external-id has been given with original onboarding API request, it is included automatically to help you to match the new Ropo One Profile apikey with the correct Business ID in your ERP.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://dev.ropo.com/guides/general-add-ons/onboarding/onboarding-apikey-endpoint.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.