---
title: "Send an invite to a provider user"
method: POST
path: "/v2/providers/{providerId}/users/invite"
tags: ["Provider user"]
---

# Send an invite to a provider user

`POST /v2/providers/{providerId}/users/invite`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/{providerId}/users/invite`
- Auth: none required
- TypeScript: <https://skmtc.dev/loket-acc/apis/loket-api/docs/v2/providers/:providerId/users/invite/post.ts> (a function with typed inputs; its response is checked against the schema)

__Activity name :__ PostInviteProviderUserByProviderId

__Metadata :__  Possible options for fields of the type 'metadata' can be acquired via /v2/providers/providers/{providerId}/users/metadata

__Defaults :__ Default values for a new object can be acquired by via /v2/providers/providers/{providerId}/users/defaults

Send an invite to an user for an provider user.

## Path parameters

- `providerId` string, uuid, required

## Headers

- `Authorization` string, required
- `Accept` string, required

## Request body

- UserInvite
  - `personalDetails` object
    - `initials` string: The initials of the user
    - `prefix` string, nullable: The prefix of the user
    - `lastName` string: The last name of the user
  - `contactInformation` ContactInformation4
    - `placeOfEmployment` string, nullable: The place of employment (standplaats) for the user.
    - `phoneNumber` string, nullable: The phone number of the user.
    - `emailAddress` string: The e-mail address of the user.
  - `twoFactorAuthenticationRequired` boolean: Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO
  - `hasAccessToPayrollingTestData` boolean: Indicates if the user has access to data for payrolling test years
  - `destinationForSecret` string: The destination phonenumber to sent the secret to during registration.

## Response `201`

Created

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `content` UserGetAndPut
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `loginMethod` LoginMethod: The allowedlogin method for the user
      - `key` integer
      - `value` string
    - `personalDetails` object
      - `firstName` string, nullable: The first name of the user
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
    - `contactInformation` ContactInformation4
      - `placeOfEmployment` string, nullable: The place of employment (standplaats) for the user.
      - `phoneNumber` string, nullable: The phone number of the user.
      - `emailAddress` string: The e-mail address of the user.
    - `userSpecifiedRole` UserSpecifiedRole, nullable: The Role which the user has specified.
      - `key` integer
      - `value` string
    - `userCustomSpecifiedRole` string, nullable: Further specification of the user role.
    - `accessStatus` AccessStatus: indicates the access status of the user.
      - `key` integer
      - `value` string
    - `hasMultiFactorAuthentication` boolean: Indicates if the user has multi factor authentication enabled Can only be changed from true to false.
    - `twoFactorAuthenticationRequired` boolean: Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO
    - `azureActiveDirectory` AzureActiveDirectory, nullable
      - `tenant` object: The Azure AD tennant
        - `id` string, uuid: Id for the tennant
        - `description` string
        - `tenantRegistrationLevel` 'provider' | 'provider'
      - `userId` string: The userId as known in the Azure AD of the selected tennant
    - `userName` string, nullable: The username
    - `hasIntegrations` boolean: Indicates if the user has integrations with clients other that Loket
    - `hasConnectedApplications` boolean: Indicates if the user has connected applications (a conection with different software via this user)
    - `hasAuthorisationsOnUserLevel` boolean: Indicates if the user has authorizations set on user level. If set user level authorizations overwrite team based authorizations
    - `dateTimeLastLogin` string, date-time, nullable: The date on which the user loged in for the last time
    - `dateTimeCreation` string, date-time: The date on which the user was created
    - `authorizationSet` AuthorizationSet, nullable: The authorization set for the user.
      - `key` integer
      - `value` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket-acc/apis/loket-api.md) - [All operations](https://skmtc.dev/loket-acc/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket-acc/apis/loket-api/revisions/18447d65a986?raw)