Register Account API Documentation

The Register Account endpoint creates a security profile for an existing member within the Avios loyalty platform. The member may have joined from any partner or Avios channel, including offline channels. Registration stores the security credentials that enable the member to log in , along with other data elements such as security responses that enable the member to recover credentials in the future. Registration will only be successful if the member doesn’t have an existing security profile.

The credentials held within the security profile are used to identify the member when they log in to Avios and partner applications, including when a member pays with Avios . The same credentials are used by the member across the entire Avios ecosystem.

Business Context

Here’s the process flow:

• The member provides their details in the partner’s channel.
• The partner calls the Register Account endpoint.
• The Register Account endpoint processes the request and returns either success or failure.
• The partner finalises the account registration process in their channel.
• The partner confirms the outcome to the member and allows the member to continue their journey.

Important Technical Notes

• This API can receive upper or lower case ASCII or accented data but this will be converted to uppercase ASCII. The response message will contain only upper case ASCII characters. This conversion is a one-way process, converted ASCII character cannot be translated back to original accented character.

Pre-conditions

• The account must exist within the Avios loyalty platform for the member
• The account must not have an existing security profile
• The account must be active
• Partner must have an API key to call Register Account endpoint.

Post-conditions

Success outcome: HTTP status code 201 is returned with an empty response body.

Error outcome: Refer to error code table for list of possible error responses.

Service Details

URI Parameters

Production Endpoint:

`POST https://api.avios.com/{version}/memberships/{membership-identifier}/registrations?api_key={api_key}`

Example

https://api.avios.com/v2/memberships/3081470000000000/registrations?api_key=abcdefabcdefabcdefabcdef

Request Headers

Request Elements

The following is an example of a valid request body for the Register Account endpoint.

{
  "member": {
    "securityProfile": {
      "credentials": {
        "identifier": "my.name@email.com",
...Show more

The elements that make up the request message are detailed in the following table and the following rules apply:

• Request element’s values may be sent as either upper, lower case ASCII characters or accented characters.
• Default values are not assigned to elements that have not been supplied within a request message
• Appendix A shows an example of a Register Account endpoint request call, expressed in JSON format

Response Message

The Register Account API response is limited to mitigate any information disclosure vulnerability. A typical response will return success or failure as an HTTP status code, in this case a 201 for success. In the event of an error occurring, an appropriate error message will be returned.

Exception Message Elements

The following is an example of an error response.

{
  "error": {
    "code": "SECURITY_PROFILE_ALREADY_EXISTS",
    "businessMessage": "Security Profile Already Exists",
    "developerLink": "https://developer.iagloyalty.com/docs"
...Show more

Error Codes