Register client organisation

POST

/business/v1/businesses/{businessUuid}/business-collaborators

Creates a client organisation in CREATED status, links it to the calling collaborator (the
organisation identified by the path parameter and the tenant header) with the declared
collaboratorType, registers its initial product catalogue, and triggers an invitation for
each initial user. The link is fixed to the declared role. The caller does not become a
user or administrator of the created organisation.

The products field selects which of the calling collaborator's own active products are
registered for the client: omitted defaults to every active product the collaborator itself
holds under the declared collaboratorType; when present, every declared code must be one
of them.

Security rules:

• The x-tenant-id header must match the businessUuid path parameter.
• The x-tenant-id header must match the tenant_id claim contained in the access token (JWT).

Autorizaciones

OAuth2ClientCredentials

OAuth2 Client Credentials for machine-to-machine access. The access token must include scope API_INTERNAL (internal service-to-service) or API (external M2M integrations).

clientCredentials Flow

URL del token"/idp/oauth2/token"

Ámbitos:

• "API_INTERNAL"Internal API scope
• "API"External M2M API scope

Parámetros

Header Parameters

x-tenant-id*

Tenant identifier that contains the organisation UUID

Tipo

string

Requerido

Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"

Formato

"uuid"

Path Parameters

businessUuid*

Unique identifier of the organisation.

Tipo

string

Requerido

Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"

Formato

"uuid"

Cuerpo de la petición

application/json

{

  

"taxId": "7377473W",

  

"type": "COMPANY",

  

"legalName": "My company",

  

"tradeName": "My company trade name",

  

"name": "My name",

  

"lastName": "My last name",

  

"activityCode": "20",

  

"fiscalAddress": {

  

  

"street": "Calle Uría",

  

  

"additionalInformation": "Whatever additional information",

  

  

"postalCode": "33010",

  

  

"cityCode": "ES-AS-OVIEDO",

  

  

"stateCode": "ES-AS",

  

  

"countryCode": "ES"

  

},

  

"collaboratorType": "PARTNER",

  

"users": [

  

  

{

  

  

  

"name": "Jane",

  

  

  

"lastName": "Doe",

  

  

  

"email": "[email protected]",

  

  

  

"role": "ADMINISTRATOR"

  

  

}

  

],

  

"products": [

  

  

[

  

  

  

"pagafactu",

  

  

  

"zertipay"

  

  

]

  

]

}

Respuestas

Organisation registered; invitations triggered.

Content-Type

application/json

{

  

"businessUuid": "1f56c928-7621-44fe-8cda-c211fda0a828",

  

"products": [

  

  

[

  

  

  

"pagafactu",

  

  

  

"zertipay"

  

  

]

  

]

}

POST

/business/v1/businesses/{businessUuid}/business-collaborators

Playground

Servidor

Autorización

OAuth2ClientCredentials

Headers

x-tenant-id*

Variables

Key

Value

businessUuid*

Cuerpo

Ejemplos