A Member represents an individual (i.e. employee) who has access to Recuro Health services.\

Endpoint

https://platform.wellviasolutions.com/user/v1/member\

The Member Object

Attributes

idstring :required

The unique identifier of the member.

memberTypestring :required

The unique type identifier of the member. Possible values can be found in the Member Type Dictionary.

profileobject :required

The member's profile.

firstNamestring :required

The first name of the member.

lastNamestring :required

The last name of the member.

genderstring :required

The gender of the member. Possible values can be found in the Gender Type Dictionary.

dateOfBirthdate :optional

The member's date of birth.

mobileNumberstring :optional

The member's mobile phone number. Value will be in E-164 format.

emailAddressstring :optional

The member's email address.

postalAddressobject :optional

The member's postal address.

idstring :required

The unique identifier.

typestring :required

The unique type identifier. Possible values can be found in the Postal Address Type Dictionary.

addressLine1string :required

The first line of the address.

addressLine2string :optional

The second line of the address.

citystring :required

The city.

statestring :required

The USPS 2 character state abbreviation.

zipCodestring :required

The USPS zip code.

countryCodestring :required

The country code is in ISO 3166-1 format.

isDefaultboolean :required

Specifies if this address is the member's primary address.

sortPrioritynumeric :optional

Specifies the priority order this address should be listed.

alternativeIdsdictionary :optional

A dictionary containing additional unique identifiers for the member.

keystring :required

The unique type identifier. Possible values can be found in the Member Identifier Type Dictionary.

valuestring :required

The unique member identifier.

serviceOfferingIdstring :required

The unique identifier for the service offering the member is assigned to.

organizationobject :required

Details about the organizational structure the member belongs to.

clientIdstring :required

The unique client identifier.

clientNamestring :required

The client's displayed name.

groupIdstring :required

The unique group identifier.

groupNamestring :required

The group's displayed name.

familydictionary :required

A dictionary containing family members under the same account.

keystring :required

The unique member identifier.

valuestring :required

The unique type identifier. Possible values can be found in the Member Type Dictionary.

Example

{
	"id": "mem_3a272fa3c9634ebfab2ef8e494d663fb",
	"type": "primary",
	"profile": {
		"firstName": "John",
		"lastName": "Doe",
		"gender": "M",
		"dateOfBirth": "1970-01-01T00:00:00",
		"emailAddress": "[email protected]",
		"mobileNumber": "+15551234567",
		"postalAddress": {
			"id": null,
			"type": null,
			"addressLine1": "555 Nowhere Ln",
			"addressLine2": "Apt 12",
			"city": "Dallas",
			"state": "TX",
			"zipCode": "75063",
			"countryCode": "US",
			"isDefault": false,
			"sortPriority": null
		}
	},
	"alternativeIds": {
		"clientmemberid": "d6d9c46b6b2d4c12bca09e46d7f4c938",
		"secondaryclientmemberid": "84e214d834984db59fa415a9974f873b",
		"friendlyid": "1234567"
	},
	"serviceOfferingId": "srvo_efb154ed229f4d0b8017f4390d385f23",
	"organization": {
		"clientId": "clnt_6c7e5e4e171b4b929d52e109abc388e7",
		"clientName": "Dunder Mifflin",
		"groupId": "grp_bcbeed73f9a544e28f6714b63e6ee510",
		"groupName": "Scranton Office"
	},
	"family": {
		"mem_3a272fa3c9634ebfab2ef8e494d663fb": "primary",
		"mem_217d89b15f5949dba1742a16c90ddb58": "spouse",
		"mem_bdb779039fe549f9a03749f516d9e42c": "child"
	}
}