Invites
Completes the invite by creating user/service and invalidating the invite code
In the case of a user invite, this resource will assign the new service to the existing user and disables the invite. <br>In the case of a service invite, this resource will create a new service, assign gateway account ids (if provided) and also creates a new user and assign to the service<br>The response contains the user and the service id's affected as part of the invite completion in addition to the invite
post/v1/api/invites/{code}/complete
Path parameters
codestring required
Response
OK
Example response
{
"invite": {
"_links": [
{
"href": "https://an.example.link",
"method": "GET",
"rel": "self"
}
],
"email": "example@example.gov.uk",
"is_invite_to_join_service": true,
"otp_key": "ABC123",
"role": "view-only",
"telephone_number": "+440787654534"
},
"service_external_id": "89wi6il2364328",
"user_external_id": "287cg75v3737"
}