Registration is the process of establishing a member's account for the first time. These endpoints assist in verifying account information in addition to creating the member's credentials for accessing Recuro Health portals and apps.

Endpoint

The Registration Object

Attributes

Contains a value describing the status of the verification or registration attempt. More information can be found in the Registration Status Dictionary.

The unique identifier of the matched user. Is only populated when status is matchfound or registrationcomplete.

An object populated with details regarding a multifactor authentication attempt that was made.

An object populated with details regarding a multifactor authentication attempt and the delivery mechanisms used.

Identifies the delivery method used for the multifactor authentication attempt. More information can be found in the Multifactor Authentication Delivery Method Dictionary.

The masked address that the multifactor authentication code was sent to. For instance, phone numbers lead with asterisks (*) and only show the last four digits.

Contains a value describing the status of the multifactor authentication attempt. More information can be found in the Registration Status Dictionary.

A UTC timestamp representing when the multifactor authentication code expires. By default, this will be 10 minutes from the time the request was made.

A unique code that is used when responding to a multifactor authentication request with the code provided by the member.

When available, will return a list of MFACommunication objects that can be used as an alternative to the chosen MFACommunication. By default, the API attempts to send in the following order (as available): sms, email, phone.

Example

{
	"Status": "mfarequired",
	"UserId": null,
	"MultiFactorAuthSubmission": {
		"MFACommunication": {
			"DeliveryMethod": "sms",
			"MaskedToAddress": "********1234"
		},
		"Status": "pending",
		"Expiration": "2021-04-29T07:48:28Z",
		"RequestCode": "RitEQVozaWRjLzNGM1E5dVQyN0hBT3VZUzJvRXQrbTd6RlhhY..."
	},
	"MultiFactorAuthAlternatives": [
		{
			"DeliveryMethod": "phone",
			"MaskedToAddress": "********1234"
		},
		{
			"DeliveryMethod": "email",
			"MaskedToAddress": "an*******[email protected]"
		}
	]
}