Fix binding error

Fix user binding errors by updating memberships with the API.

Who can fix binding errors

Users with binding errors can fix some errors themselves:

• emailVerifiedMatchError: User needs to verify their email address through the authorization URL.
• idVerifiedMatchError: User needs to complete the appropriate identification process.

For all other binding error types, only account members with the canManageAccountMembership permission and status Enabled can fix them by updating the mismatched information with the API:

• firstNameMatchError
• lastNameMatchError
• birthDateMatchError
• phoneNumberMatchError

Prerequisites

• You have the canManageAccountMembership permission.
• The account membership status isn't ConsentPending or Disabled.
• You're not updating the legal representative's membership (unless you're the legal representative).
• If you're granting a permission to another account member, you have that permission already. You can't grant permissions you don't have.
• You're using a user access token.

Guide

1. Call the updateAccountMembership mutation.
2. Add the accountMembershipId and your redirect URL.
3. Add only the information that caused the user binding error (lines 7-10, 12). Refer to causes of a user binding error for precise information.
4. Add the success payload with the consentUrl.
5. Add any rejections you'd like (starting on line 21).
6. Get the consentUrl from the payload and send it to the invited account member. They must consent to finalize the update.

Mutation

Open in API Explorer

mutation FixBindingError {
  updateAccountMembership(
    input: {
      accountMembershipId: "$ACCOUNT_MEMBERSHIP_ID"
      consentRedirectUrl: "$YOUR_CONSENT_REDIRECT_URL"
      restrictedTo: {
        birthDate: "$CORRECT_BIRTH_DATE"
        firstName: "$CORRECT_FIRST_NAME"
        lastName: "$CORRECT_LAST_NAME"
        phoneNumber: "$CORRECT_PHONE_NUMBER"
      }
      email: "$CORRECT_EMAIL"
    }
  ) {
    ... on UpdateAccountMembershipSuccessPayload {
      __typename
      consent {
        consentUrl
      }
    }
    ... on AccountMembershipCannotBeUpdatedRejection {
      id
      message
    }
    ... on AccountMembershipNotFoundRejection {
      id
      message
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on InvalidPhoneNumberRejection {
      __typename
      message
    }
    ... on PermissionCannotBeGrantedRejection {
      __typename
      message
    }
    ... on UserNotAllowedToManageAccountMembershipRejection {
      __typename
      message
    }
    ... on ValidationRejection {
      __typename
      message
      fields {
        code
        message
        path
      }
    }
  }
}

Causes of a user binding error

At least one of the following booleans must be true for an account membership to have a user binding error:

Error	If true	Update
firstNameMatchError	There's a mismatch with the first or given name.	Update restrictedTo > firstName.
lastNameMatchError	There's a mismatch with the last name or birth last name.	Update restrictedTo > lastName.
birthDateMatchError	There's a mismatch with the birth date.	Update restrictedTo > birthDate.
phoneNumberMatchError	There's a mismatch with the phone number.	Update restrictedTo > phoneNumber.
emailVerifiedMatchError	There's a mismatch with the email, or the user didn't verify their email.	Update email, or send user new authorization URL to verify email.
idVerifiedMatchError	The user wasn't assigned the right identification level.	The user needs to complete another identification process.