API Documentation
Main SiteContact Us

Send Invitation

post
https://dev-selfie-api.alocity.com/v1/invite/invitation

This endpoint will create and send an invitation to enroll a face in our system.

Controlled Errors

These are the error codes that will be returned when the hasErrors property is equal to true.

Error CodeError Message
error_account_not_foundThe account associated with the session Id provided was not found.
error_invitation_duplicateAnother invitation with the same correlation Id was found.
error_organization_not_foundThe organization provided was not found.
error_invitation_not_addedFailed to add the invitation to our system.
Body Params
string

A Guid Id of the event for your purposes. Each correlation Id provided must be unique.

string

The email of the user to send the invitation to. Either this or the phone number must be provided.

string

The phone number of the user to send the invitation to. Either this or the email must be provided. The format for phone numbers must be as follows: +13055551212 where no - are used in the phone number.

string

The Guid Id of the organization to associate the invitation to.

string

The Id of the user in your system to associate the face to once it is enrolled.

Headers
string
required

The session Id generated using the Authentication endpoint.

Responses

Updated over 3 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 3 years ago