Ga naar inhoud
buildinglinksbuildinglinks

Apply to the authority

POST
/api/v1/onboarding/apply
curl --request POST \
  --url https://example.com/api/v1/onboarding/apply \
  --header 'Content-Type: application/json' \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E \
  --data '{ "invite_code": "example", "legal_name": "example", "kvk_number": "example", "contact_email": "example", "requested_roles": [ "example" ], "name": "example", "color": "example", "role": "example", "signatory_name": "example", "signatory_email": "example" }'

Sends the application, signed with the participant’s DID, to the authority, and stores the organisation’s profile. The authority e-mails the signatory the rulebook declaration and the mandate to sign.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

An application to join the dataspace.

object
invite_code
string | null
legal_name
required
string
kvk_number
required

Eight digits.

string
contact_email
string | null
requested_roles

At least one; the roles the authority offers (/api/v1/onboarding/roles there).

Array<string>
name

Display name, colour and role of the organisation (registration wizard of a fresh connector). Optional: defaults stay in force.

string | null
color
string | null
role
string | null
signatory_name

Person authorised (KvK) to sign the rulebook declaration and mandate.

string | null
signatory_email
string | null

Example generated

{
  "invite_code": "example",
  "legal_name": "example",
  "kvk_number": "example",
  "contact_email": "example",
  "requested_roles": [
    "example"
  ],
  "name": "example",
  "color": "example",
  "role": "example",
  "signatory_name": "example",
  "signatory_email": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

The participant’s application to the authority, and its membership.

object
state
required

Not_started | awaiting_signature | pending | approved | active | rejected | suspended

string
application_id
string | null
submitted_at
string | null format: date-time
message
string | null
roles
Array<string>
signatory_name
string | null
signatory_email
string | null
signing

Latest signing request at the authority (state, sent/signed times, signer, document hashes).

object | null
decided_at
string | null format: date-time

Example generated

{
  "state": "example",
  "application_id": "example",
  "submitted_at": "2026-04-15T12:00:00Z",
  "message": "example",
  "roles": [
    "example"
  ],
  "signatory_name": "example",
  "signatory_email": "example",
  "signing": "example",
  "decided_at": "2026-04-15T12:00:00Z"
}

400

Section titled “400”

A field is missing or not valid.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

409

Section titled “409”

Already a member.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

502

Section titled “502”

The authority could not be reached or refused.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}