Skip to main content

Activate clients in Banqup France only ​


This API recipe guides partners and accountants through creating and activating their clients in Banqup using the "activate without invitation" workflow. By selecting this path, the partner directly handles the onboarding and workspace setup, while the client receives an invite to access their pre-configured workspace.


Prerequisites​
  • The partner and client must be based in France.
  • The partner must be an accountant (segment ACCOUNTING).
  • The client must be in status Draft, Invited or Activation failed.
  • The client's SIRET number must not already be associated with an existing Banqup space.
  • The client's business identifiers must exist in data.gouv so KYC (Know Your Customer) automated verification can validate the data.
  • 'Client manager' role is assigned to the user activating the client, which allows you to create, edit, and manage clients, but does not grant access to the documents and other data of the client.
  • partnerSpaceId: The spaceId of the partner to which the client is assigned.

Step 1: Create client

Endpoint: /workspace/partner/v1/spaces/{partnerSpaceId}/clients


Path parameter:

  • partnerSpaceId

Requires a JSON request body (see curl example below).

Parameter details:

ParameterDescriptionNotes
templateNameApplies the preset template of your choice to ensure standard baseline configurations for new clients.

Automatically configures:
• Team members (accounting partners only); can also be added later
• Subscription type and payer (client or partner)
• Integration apps		Uses the default template if parameter is omitted or the template name is invalid.
Settings can still be adjusted after creation, per client.
eInvoicingMandatedRequired for activation. Must be set to true to automatically activate the Peppol e-invoicing connector upon client creation.French Clients: Connector is auto-configured with an activation date of September 01, 2026.
identifiersBoth SIREN and SIRET numbers must be provided.VAT number is optional.
contactsPrimary contact details firstName, lastName, and userEmail are required.

curl --location 'https://{{serverURL}}/workspace/partner/v1/spaces/{spaceId}/clients' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data-raw '
{
    "name": "My Client3",
    "identifiers": {
    "fr:siren": "410409465",
        "fr:siret": "41040946000045",
        "fr:vat": "FR20410409465"
},
    "addresses": {
    "main": {
        "streetName": "Rue des Fleurs",
            "house": "80728",
            "postalCode": "3110",
            "city": "Paris",
            "country": "France",
            "countryCode": "FR",
            "postBox": "PO123"
    }
},
    "metadata" : {
    "templateName": "my_template",
        "eInvoicingMandated": true,
        "vatChargeableMethod": "invoice_date",
        "vatRegime": "01"
},
    "contacts": [
    {
        "firstName": "John",
        "lastName": "D.",
        "mobile": "+32497666003",
        "email": "john.d@example.com",
        "language": "en"
    }
]
}'

Successful response: Save the clientId returned in the response for further use.


{
    "id": "10266505-d8d8-43b8-954d-40fac11babdj",
        "name": "My Client3",
        "identifiers": {
        "fr:siren": "410409465",
            "fr:siret": "41040946000045",
            "fr:vat": "FR20410409465"
    },
    "addresses": {
        "main": {
            "streetName": "Rue des Fleurs",
                "buildingNumber": "80728",
                "postalCode": "3110",
                "city": "Paris",
                "country": "France",
                "countryCode": "FR",
                "postBox": "PO123"
        }
    },
    "metadata": {
        "templateName": "my_template",
            "eInvoicingMandated": true,
            "vatChargeableMethod": "invoice_date",
            "vatRegime": "01"
    },
    "contacts": [
        {
            "id": "b2e372c1-ac5e-49cc-bd13-46b82a04efco",
            "firstName": "John",
            "lastName": "D.",
            "mobile": "+32497666003",
            "email": "john.d@example.com",
            "language": "en"
        }
    ],
        "status": "DRAFT",
        "spaceExtensions": []
}

Step 2: Activate client

Endpoint: partner/api/v1/spaces/{spaceId}/clients:bulkActivate


Path parameter:

  • spaceId

Requires a JSON request body (see curl example below).

Generate sessionId

You must generate a unique UUID on your backend for each batch request. This sessionId allows your application to track, group, and query asynchronous jobs.

curl --location 'https://{{serverURL}}/workspace/partner/api/v1/spaces/{spaceId}/clients:bulkActivate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '
{
    "sessionId": "83485620-e0a7-45da-b761-5aadee06ff52",
    "bulkActivateClients": [
    {
        "clientId": "10266505-d8d8-43b8-954d-40fac11babdj",
        "clientName": "My Client3"
    }
]
}
}'

Successful response: The client has been activated and has been sent an email to access the newly created space.


{
    "processClients": [
        {
            "clientId": "10266505-d8d8-43b8-954d-40fac11babdj",
            "clientName": "My Client3"
        }
    ]
}
Error handling for failed activation

If automated KYC verification fails or any prerequisite is missed during activation:

  • The client’s status will automatically transition to ACTIVATION_FAILED.
  • The client activation route cannot be retried automatically. You must route the user through the standard invitation flow, where the client manually completes onboarding and verifies their business data.

Step 3: View client details

Endpoint: /workspace/partner/v1/spaces/{partnerSpaceId}/clients/{clientId}


Path parameters:

  • partnerSpaceId
  • clientId

curl -L 'https://{{serverURL}}/workspace/partner/v1/spaces/{partnerSpaceId}/clients/{clientId}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_TOKEN'

Successful response:


{
    "id": "10266505-d8d8-43b8-954d-40fac11babdj",
        "name": "My Client3",
        "identifiers": {
        "fr:siren": "410409465",
            "fr:siret": "41040946000045",
            "fr:vat": "FR20410409465"
    },
    "addresses": {
        "main": {
            "streetName": "Rue des Fleurs",
                "buildingNumber": "80728",
                "postalCode": "3110",
                "city": "Paris",
                "country": "France",
                "countryCode": "FR",
                "postBox": "PO123"
        }
    },
    "metadata": {
        "vatRegime": "01",
            "templateName": "my_template",
            "unattendedRun": {
            "error": {},
            "status": "completed",
                "timestamp": "2026-08-19T08:04:46.719Z",
                "processInstanceId": "PRC-a4c47958-9ba4-11f1-8324-7ee468702ba8"
        },
        "invitationMessage": "Pour simplifier notre processus de partage de documents, je vous invite à rejoindre Banqup. Cette solution vous permet de mieux gérer vos finances et de partager vos documents avec votre cabinet comptable.",
            "eInvoicingMandated": true,
            "vatChargeableMethod": "invoice_date"
    },
    "contacts": [
        {
            "id": "9aefde72-5b59-4e42-885r-63c383352488",
            "firstName": "John",
            "lastName": "D.",
            "mobile": "+32497666003",
            "email": "john.d@example.com",
            "language": "en"
        }
    ],
        "status": "ACTIVE",
        "clientSpaceUrl": "SPACE_URL",
        "clientEntityId": "9ca03374-0c89-4f43-86f7-7d1673c8b439",
        "clientSpaceId": "e523184d-51c4-4506-97c7-c90357992199",
        "spaceExtensions": []
}