# Code and Formats source: https://developer.mastercard.com/user-account-management-service/documentation/code-and-formats/index.md ## Errors Overview {#errors-overview} The User Account Management Service uses standard HTTP response codes for success and failure notifications, and our errors are further classified by error type. In general, 200 HTTP codes correspond to success, 40X codes are for the developer or user-related failures, and 50X codes are for runtime or system errors. This section contains information about the response codes and error messages that can be returned by the APIs. ## Application Error Codes {#application-error-codes} ### Error Structure {#error-structure} 4xx/5xx error response messages have the following format (the Error array may contain multiple error items): ```json { "Errors": { "Error": [ { "Source": "", "Description": "", "Recoverable": "true/false", "Details": "null" } ] } } ``` | Field | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Source** | The application (user-management-api) generates this error. Every error message that is generated and returned by the gateway will have this field equal to Gateway. When the value of the source field is something else, it means that the error was generated elsewhere. For example, the user-management-api. | | **ReasonCode** | The general cause of the error; see the table below. For example, `INVALID_INPUT`, `ACCOUNT_NOT_FOUND`. | | **Description** | A textual description of the error. This is optional and will only be displayed if more information is available than is stored in the data identifier and reason code. For example, `userId` parameter cannot be null. | | **Recoverable** | A true/false indicator stating whether your API request might be successful if you re-sent the API request with the same parameters and data. For example, an unsuccessful API request caused by a server error (5xx response code) might be successful when re-sent. Valid values: true, false | | **Details** | Each Open API service has the option to add extra service-specific error information in the Details section. The details are optional and might not be present for every error message. If present, the details are returned in the form of individual detail items, each containing a Name and Value pair. | ## HTTP Response Codes {#http-response-codes} The following is a complete list of the response codes that the application may return for requests. In the event of network or infrastructure issues, other response codes may be returned by the infrastructure. Note: For further information about 4xx/5xx response codes and possible resolutions, see [Gateway Error Codes](https://developer.mastercard.com/platform/documentation/security-and-authentication/gateway-error-codes/). | HTTP Response Code | Description | |---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 200 (OK) | The request was completed successfully. | | 400 (BAD REQUEST) | General error when the request could not be fulfilled due to errors such as validation errors, or missing required data. | | 401 (UNAUTHORIZED) | Error code response for missing or invalid authentication token (for example, a client with a clientId does not have access). | | 403 (FORBIDDEN) | The user is not authorized to operate or the resource is unavailable for some reason (for example, time constraints). | | 404 (NOT FOUND) | The requested resource is not found. | | 405 METHOD NOT ALLOWED | Used to indicate that the requested URL exists, but the requested HTTP method is not applicable. For example, POST /users/12345 where the API does not support the creation of resources this way (with a provided ID). The Allow HTTP header must be set when returning a 405 to indicate the HTTP methods that are supported. In the previous case, the header would look like "Allow: GET, PUT, DELETE". | | 500 INTERNAL SERVER ERROR | The server encountered an unexpected condition that prevented it from fulfilling the request. It indicates an error that the caller cannot address from their end. Requests resulting in a 500 response code will generally include the User Management API Errors structure in the response. | | 5XX SERVER ERROR | Errors that occur in the network infrastructure between the client and the User Management API server will typically result in a response code in the 500 range. Note that errors returned by the network infrastructure will never contain the User Management API Errors structure in the response. | ## User Account Management Error Codes {#user-account-management-error-codes} Note: This API service does not support retry logic that returns the same response as the initial request. If retried, the API will respond with a 4xx error indicating a duplicate request, with a reason code, such as `Multiple_users_found` or `Multiple_accounts_found`. ### Common error codes across endpoints {#common-error-codes-across-endpoints} The following error codes are common across all services and applicable to every endpoint. | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|----------------------------|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 401 | PROGRAM_MAPPING_ERROR | No Enterprise Site record found for ClientId. | This is a Configuration issue. Work with your assigned regional manager or product delivery team to set up this configuration. | | 401 | UNAUTHORIZED | Client Identity is unknown. | Client Id is missing in the request. Send a valid client id along with the request. If you are still seeing this issue, then work with your assigned regional manager or product delivery team for this configuration. | | 401 | SITE_PROGRAM_MAPPING_ERROR | No access to enroll in the program. | This is a Configuration issue. Work with your assigned regional manager or product delivery team to set up this configuration. | | 500 | INTERNAL_SERVER_ERROR | System error occurred in enrollment. | Internal server error can be thrown for unknown reasons. Work with your assigned regional manager or product delivery team for this configuration. | | 401 | ACCOUNT_NOT_FOUND | The `accountId` in the request is not valid. | Provide a valid `accountId` (BAN/RANAC) in the request. | | 401 | MULTIPLE_ACCOUNTS_FOUND | Multiple RANACs are associated with a single `accountId`. | A duplicate `accountId` (BAN) was found. Work with your assigned regional manager or product delivery team for this configuration. | | 401 | USER_NOT_FOUND | The `userId` in the request is not valid. | Provide a valid `userId` (BCN/RANCU) in the request. | | 401 | MULTIPLE_USERS_FOUND | Multiple RANCUs are associated with a single `customerId`. | A duplicate `userId` (BCN) was found. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | DECRYPTION_ERROR | Failed to decrypt the request body. | Unable to decrypt the request. Ensure that a valid decryption certificate is used. | | 400 | ENCRYPTION_ERROR | The request body is not encrypted. | Ensure that the request body is encrypted. | | 400 | LUHN_CHECK_ERROR | Luhn check validation failed. | Luhn check validation failed for `accountId`. Provide a valid `accountId`. | ### POST /accounts {#post-accounts} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------------------------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | Supported value for `userIdType` is BCN or RANCU. | Refer to the correct field value mentioned in the account enroll endpoint API reference here [EnrollAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#enroll-account/), and try again. | | 400 | INVALID_INPUT | Supported value for `accountIdType` is BAN. | Refer to the correct field value mentioned in the account enroll endpoint API reference here [EnrollAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#enroll-account/), and try again. | | 400 | INVALID_INPUT | Supported values for accountStatus are NEW and GOOD_STANDING. | Refer to the correct field value mentioned in the account enroll endpoint API reference here [EnrollAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#enroll-account/), and try again. | | 400 | INVALID_INPUT | When `accountStatus` is Good Standing, the `accruePoints` cannot be false. | Refer to the correct field value mentioned in the account enroll endpoint API reference here [EnrollAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#enroll-account/), and try again. | | 400 | INVALID_INPUT | A specific parameter in the request has invalid characters. | Refer to the correct field value mentioned in the account enroll endpoint API reference here [EnrollAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#enroll-account/), and try again. | | 401 | INVALID_MEMBER_ICA | companyICA is not valid. | Company ICA does not exist, or end dated. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | INVALID_PROGRAM_IDENTIFIER | The program identifier is not valid. | Provide a valid Program Identifier. The Program Identifier sent in the request is not valid or does not exist. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | ACCOUNT_ALREADY_EXIST | Account already exists. | Provide a unique `accountId` (BAN) which is not enrolled. | | 400 | INVALID_PRODUCT_CODE | `productCode` is not valid. | Provide a valid Bank Product Code. The Bank Product Code sent in the request is not valid or does not exist. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | ACCOUNT_ALREADY_ENROLLED | The account is already enrolled. | Provided `accountId` (BAN) is already Enrolled under userId (BCN). | | 400 | ENROLLMENT_FILTER_ERROR | Enrollment filter validations failed. | Enrollment filter validations failed. Check program parameter configurations related to card enrollment. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | PROGRAM_CONFIG_ERROR | The program is not subscribed to enrollment service. | Ensure that the program is mapped to the enrollment service method. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | ADDITIONAL_ACCOUNTS_NOT_ALLOWED | The program is not configured to allow enrolling additional accounts under an existing user. | Enable program configuration to allow enrolling additional accounts under an existing user. | ### GET /accounts/{id} {#get-accountsid} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | Supported value for account_id_type is RANAC. | Refer to the correct field value mentioned in the Retrieve Account endpoint API reference here [RetrieveAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#retrieve-account), and try again. | | 400 | INVALID_INPUT | offset cannot be negative. | Refer to the correct field value mentioned in the retrieve account endpoint API reference here [RetrieveAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#retrieve-account), and try again. | | 400 | INVALID_INPUT | limit must be greater than 0. | Refer to the correct field value mentioned in the retrieve account endpoint API reference here [RetrieveAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#retrieve-account), and try again. | | 400 | INVALID_INPUT | limit must not be greater than 25. | Refer to the correct field value mentioned in the retrieve account endpoint API reference here [RetrieveAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#retrieve-account), and try again. | | 400 | INVALID_INPUT | Either user_id_type or account_id_type is required. | Refer to the correct field value mentioned in the retrieve account endpoint API reference here [RetrieveAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#retrieve-account), and try again. | | 400 | INVALID_INPUT | Supported value for user_id_type is RANCU. | Refer to the correct field value mentioned in the retrieve account endpoint API reference here [RetrieveAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#retrieve-account), and try again. | ### PUT /account-groups {#put-account-groups} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|--------------------------------------|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | The supported value for sourceIdType is RANAC. | Refer to the correct field value mentioned in the account groups endpoint API Reference here [AccountGroup](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#group-accounts), and try again. | | 400 | INVALID_INPUT | Invalid actionCode. Permitted values are MA, MH, DA, DH. | Refer to the correct field value mentioned in the account groups endpoint API Reference here [AccountGroup](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#group-accounts), and try again. | | 400 | INVALID_INPUT | targetId cannot be null or empty. | Refer to the correct field value mentioned in the account groups endpoint API Reference here [AccountGroup](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#group-accounts), and try again. | | 400 | INVALID_INPUT | targetIdType cannot be null or empty and should be HHID. | Refer to the correct field value mentioned in the account groups endpoint API Reference here [AccountGroup](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#group-accounts), and try again. | | 400 | INVALID_INPUT | targetId must be numeric. | Refer to the correct field value mentioned in the account groups endpoint API Reference here [AccountGroup](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#group-accounts), and try again. | | 400 | INVALID_INPUT | Supported value for targetIdType is HHT. | Refer to the correct field value mentioned in the account groups endpoint API Reference here [AccountGroup](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#group-accounts), and try again. | | 400 | INVALID_INPUT | targetId is already used. | Refer to the correct field value mentioned in the account groups endpoint API Reference here [AccountGroup](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#group-accounts), and try again. | | 400 | INVALID_INPUT | source account already exists in target account group. | Check your request params and try again. | | 400 | INVALID_INPUT | Cancelled Accounts cannot be moved. | Make sure the source account is not in a cancelled status and try again. | | 400 | INVALID_INPUT | targetId is not eligible. | TargetId used does not have primary redeemer status. Use an eligible targetId and try again. | | 400 | SOURCE_ACCOUNT_NOT_PERMITTED_TO_MOVE | Source account cannot move to target account group in a different program. | Source account cannot move to target account group in a different program. Provide a target account group under same program. | | 400 | NO_PRIMARY_ACCOUNT_IN_TARGET | Target account group does not have a primary account. | Target account group does not have a primary account. Provide another target account group under same program. | | 400 | MULTIPLE_PRIMARY_ACCOUNTS_IN_TARGET | Multiple Primary Accounts found in target account group. | Target account group should not have multiple primary accounts. Provide another target account group under same program. | | 400 | INVALID_SOURCE_ACCOUNT_STATUS | Source account does not have a valid status in the account group. | Make sure that the source account has an active account group. | | 400 | ACCOUNT_GROUPING_FAILED | Unable to update account group. Check the `Details` field and contact the support team. | Unable to update account group. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | SOURCE_TARGET_SAME_GROUP | sourceId and targetId are in same account group. | The sourceId and targetId can not belong to same account group. Make sure to move to a different target account group. | | 400 | TARGET_ACCOUNT_NOT_GOOD_STANDING | Target account group does not have an account in good standing. | Target account group does not have an account with GOOD_STANDING status. Provide a valid target account group having active primary account. | | 400 | TARGET_ACCOUNT_LOST_STOLEN | Primary account in target account group is lost/stolen. | Primary account in target account group is lost/stolen. Provide another target account group under same program or update primary account in target account group. | | 400 | TARGET_ACCOUNT_NOT_SUPPORT_GROUPING | Target account group's program does not support account grouping. | Target account group's program does not support account grouping. Work with your assigned regional manager or product delivery team to allow account grouping for the program. | | 400 | SOURCE_ACCOUNT_LOST_STOLEN | Source account is lost/stolen. | Source account is lost/stolen. Provide a valid account. | | 400 | SOURCE_ACCOUNT_NOT_SUPPORT_GROUPING | Source account program does not support account grouping. | Source account's program does not support account grouping. Work with your assigned regional manager or product delivery team to allow account grouping for the program. | | 400 | SOURCE_ACCOUNT_NOT_GOOD_STANDING | Source account is not in good standing. | Source account is not in good standing. Update source account status to GOOD_STANDING to perform this action. | | 400 | ACCOUNT_GROUP_LIMIT_EXCEEDED | Target account group already contains maximum number of accounts. | Target account group already contains maximum number of accounts. Use different target account group id and try again. | ### PUT /accounts {#put---accounts} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|----------------------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | Supported value for `accountIdType` is RANAC. | Refer to the correct field value mentioned in the update account endpoint API Reference here [UpdateAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#update-account), and try again. | | 400 | INVALID_INPUT | bankProductCode cannot be null or empty if productTransfer is true. | Refer to the correct field value mentioned in the update account endpoint API Reference here [UpdateAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#update-account), and try again. | | 400 | INVALID_INPUT | cycleId is not valid. | Refer to the correct field value mentioned in the update account endpoint API Reference here [UpdateAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#update-account), and try again. | | 400 | INVALID_INPUT | Customer already has an account with the BankProductCode. | Refer to the correct field value mentioned in the update account endpoint API Reference here [UpdateAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#update-account), and try again. | | 400 | INVALID_INPUT | Both account status and primary account switch can't be updated in the same request. | Refer to the correct field value mentioned in the update account endpoint API Reference here [UpdateAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#update-account), and try again. | | 400 | INVALID_INPUT | Cancelled account can not be made primary in the Account Group. | Update account status to good standing to perform this action. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | INVALID_INPUT | Bank Product Code is not valid. | Refer to the correct field value mentioned in the update account endpoint API Reference here [UpdateAccount](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-management/index.md#update-account), and try again. | | 400 | ELIGIBLE_ACCOUNT_NOT_FOUND | Unable to update the primary flag. There is no other eligible account found in the account group. | To update the primary flag for the given account, the account group must have another active account. | | 400 | PRIMARY_ACCOUNT_NOT_FOUND | Unable to update the primary flag. There is no other primary account found in the account group. | To update the primary flag for the given account, the account group must have a primary account. | ### POST /cls/accounts/activations {#post-clsaccountsactivations} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------------------------|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | Supported value for userIdType is RANAC. | Refer to the correct field value mentioned in the add CLS activation endpoint API Reference here [AddCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#add-card-linked-services-cls-offer-activation), and try again. | | 400 | INVALID_INPUT | supported value for activationStatus is A or I. | Refer to the correct field value mentioned in the add CLS activation endpoint API Reference here [AddCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#add-card-linked-services-cls-offer-activation), and try again. | | 400 | INVALID_INPUT | transactionFilterCode is not valid. | Refer to the correct field value mentioned in the add CLS activation endpoint API Reference here [AddCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#add-card-linked-services-cls-offer-activation), and try again. | | 400 | INVALID_INPUT | activationStatus cannot be null or empty. | Refer to the correct field value mentioned in the add CLS activation endpoint API Reference here [AddCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#add-card-linked-services-cls-offer-activation), and try again. | | 400 | DUPLICATE_RECORD | Duplicate record found while adding Mapped Record. | Provide a unique activationId while sending in the request or do not provide any value in the activationId as it is a UUID. | | 400 | INVALID_TRANSACTION_FILTER_CODE | Map Type code is invalid for the Map Type Program. | Use appropriate map type code based on map type program. | | 400 | MAPPING_FAILED | Unable to perform the mapping. Check the `Details` field and contact the support team. | This error can be thrown for unknown reasons. Work with your assigned regional manager or product delivery team for this configuration. | ### PUT /cls/accounts/{account_id}/activations/{activation_id} {#put-clsaccountsaccount_idactivationsactivation_id} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|------------------------------|----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | supported value for activationStatus is A or I. | Refer to the correct field value mentioned in the update account activations endpoint API Reference here [UpdateCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#update-card-linked-services-cls-offer-activation), and try again. | | 400 | INVALID_INPUT | transactionFilterCode is not valid. | Refer to the correct field value mentioned in the update account activations endpoint API Reference here [UpdateCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#update-card-linked-services-cls-offer-activation), and try again. | | 400 | INVALID_INPUT | activationStatus cannot be null or empty. | Refer to the correct field value mentioned in the update account activations endpoint API Reference here [UpdateCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#update-card-linked-services-cls-offer-activation), and try again. | | 400 | TRANSACTION_FILTER_CODE_NULL | Transaction Filter Code cannot be null or empty. | Provide a valid transactionFilterCode in the request. | | 400 | MAPPING_FAILED | Unable to perform the mapping. Check the `Details` field and contact the support team. | This error can be thrown for unknown reasons. Work with your assigned regional manager or product delivery team for this configuration. | ### GET /cls/accounts/{account_id}/activations {#get-clsaccountsaccount_idactivations} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | account_id cannot be null or empty. | Refer to the correct field value mentioned in the get account activations API Reference here [RetrieveCLS](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/cls-offer-activation/index.md#retrieve-card-linked-services-cls-offer-activations), and try again. | ### POST /accounts/pan-blocks {#post---accountspan-blocks} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|-----------------|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | Supported value for `accountIdType` is BAN. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 400 | INVALID_INPUT | beginDate should be greater than or equal to current date. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 400 | INVALID_INPUT | endDate should be greater than or equal to current date. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 400 | INVALID_INPUT | beginDate should be less than or equal to endDate. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 400 | INVALID_INPUT | Invalid date format. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 400 | INVALID_INPUT | beginDate should be less than or equal to existing endDate. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 400 | INVALID_INPUT | endDate should be greater than or equal to existing beginDate. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 400 | INVALID_INPUT | Program Identifier is not valid. | Refer to the correct field value mentioned in the pan block API Reference here [PanBlock](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/pan-block/index.md), and try again. | | 500 | PAN_BLOCK_ERROR | Error occurred while doing PAN block for auto enrollment. | This error can be thrown for unknown reasons. Work with your assigned regional manager or product delivery team for this configuration. | ### POST /users {#post---users} | Reason Code | Description | HTTP Response Code | Resolution Steps | |----------------------------|----------------------------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | INVALID_INPUT | supported value for `accountIdType` is BAN. | 400 | Refer to the correct field value mentioned in the user enrollment API Reference here [EnrollUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#enroll-user), and try again. | | INVALID_INPUT | supported value for userIdType is BCN. | 400 | Refer to the correct field value mentioned in the user enrollment API Reference here [EnrollUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#enroll-user), and try again. | | INVALID_INPUT | Supported values for accountStatus are NEW and GOOD_STANDING. | 400 | Refer to the correct field value mentioned in the user enrollment API Reference here [EnrollUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#enroll-user), and try again. | | INVALID_INPUT | When account status is Good Standing then accruePoints cannot be false. | 400 | Use a valid account status and accruePoints combination and try again. | | INVALID_INPUT | A specific parameter in the request has invalid characters. | 400 | Refer to the correct field value mentioned in the user enrollment API Reference here [EnrollUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#enroll-user), and try again. | | INVALID_INPUT | BCN cannot be greater than 30 characters. | 400 | Refer to the correct field value mentioned in the user enrollment API Reference here [EnrollUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#enroll-user), and try again. | | INVALID_MEMBER_ICA | companyICA is not valid. | 401 | Company ICA does not exist, or end dated. Work with your assigned regional manager or product delivery team for this configuration. | | INVALID_PROGRAM_IDENTIFIER | Program identifier is not valid. | 400 | Send a valid Program identifier in the request. | | USER_ALREADY_EXIST | User already exists. | 400 | User already exists. Retry with a new userId (BCN). | | INVALID_PRODUCT_CODE | productCode is not valid. | 400 | Use a valid product code in the request. | | ENROLLMENT_FILTER_ERROR | Enrollment filter validations failed. | 400 | Enrollment filter validations failed. Check program parameter configurations related to card enrollment. Work with your assigned regional manager or product delivery team for this configuration. | | PROGRAM_CONFIG_ERROR | Configuration error. The program is not mapped to the enrollment service method. | 400 | Ensure the program is mapped to the enrollment service method. Work with your assigned regional manager or product delivery team for this configuration. | ### PUT /users {#put----users} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | supported value for userIdType is RANAC or RANCU. | Refer to the correct field value mentioned in the update user API Reference here [UpdateUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#update-user), and try again. | ### GET /users/{id} {#get----usersid} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | supported value for user_id_type is RANAC or RANCU. | Refer to the correct field value mentioned in the get user API Reference here [RetrieveUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#retrieve-user), and try again. | | 400 | INVALID_INPUT | language in the request is not valid. | Send a valid language in the request. Refer to the correct field value mentioned in the get user API Reference here [RetrieveUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#retrieve-user), and try again. | | 400 | INVALID_INPUT | Security questions are not configured in the cardholder's program. | Set `include_verification_details` in the request to false and try again. | | 400 | INVALID_INPUT | Verification details were not found for the User. | Set up verification details or set `include_verification_details` in the request to false and try again. | ### POST /users/references/searches {#post----usersreferencessearches} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------|----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | supported value for userIdType is RANAC, RANCU, BAN, BCN or MBL. | Refer to the correct field value mentioned in the Lookup Identifiers API Reference here [LookupIdentifiers](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/lookup-identifiers/index.md), and try again. | | 400 | INVALID_INPUT | programIdentifier can only be used when userIdType is BAN,BCN or RANCU. | Remove `programIdentifier` from the request. | | 400 | INVALID_INPUT | user_id_type is required. | Refer to the correct field value mentioned in the Lookup Identifiers API Reference here [LookupIdentifiers](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/lookup-identifiers/index.md), and try again. | | 400 | INVALID_INPUT | User identifier AREF must be 20 characters long. | Enter a 20-character AREF. | | 400 | INVALID_INPUT | User is not allowed to request Sensitive Information. | Change includeSensitiveIdentifiers field in the request to false. | | 400 | INVALID_INPUT | The requested client does not have access. Check the `Details` field and contact the support team. | The AREF provided in the request does not have access. Change the request parameters. | | 400 | INVALID_INPUT | No primary account found. | Send a valid userId in the request. | ### POST /lost-stolen-cards {#post--lost-stolen-cards} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | status cannot be null or empty when `actionCode` is either A or B. | Refer to the correct field value mentioned in the Lost Stolen API Reference here [LostStolen](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/lost-stolen-card/index.md), and try again. | | 400 | INVALID_INPUT | `oldAccountId` cannot be null or empty. | Refer to the correct field value mentioned in the Lost Stolen API Reference here [LostStolen](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/lost-stolen-card/index.md), and try again. | | 400 | INVALID_INPUT | `newAccountNumber` cannot be null or empty when `actionCode` is either `A` or `B`. | Refer to the correct field value mentioned in the Lost Stolen API Reference here [LostStolen](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/lost-stolen-card/index.md), and try again. | | 400 | INVALID_INPUT | `newCustomerNumber` cannot be null or empty when `actionCode` is either `C` or `S`. | Refer to the correct field value mentioned in the Lost Stolen API Reference here [LostStolen](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/lost-stolen-card/index.md), and try again. | | 400 | BANK_CUSTOMER_NUMBER_SAME | New bank customer number is the same as the previous bank customer number. | Provide a unique bank customer number while performing `actionCode` `C` or `S`. | | 400 | BANK_ACCOUNT_NUMBER_SAME | New bank account number is the same as the previous bank account number. | Provide a unique bank account number while performing `actionCode` `A` or `B` | | 400 | LOST_STOLEN_FOUND | Previous account found lost or stolen. | This error is thrown when the account you are trying to perform the `lostStolen` operation on is already lost or stolen. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | INACTIVE_ACCOUNT_STATUS | Previous account status is Inactive. | Make sure the account you are trying to perform lost/stolen is not in inactive status. | | 400 | REPLACEMENT_ACCOUNT_FAILED | Replacement bank account number failed checksum validation. | This error is thrown if the replacement bank account number `bank_product_id` `checksum_type_cd` value is set to `Y`. Work with your assigned regional manager or product delivery team for this configuration. | | 400 | NEW_ACCOUNT_STATUS_INACTIVE | The new account status is invalid or inactive. | The Status should not be invalid or INACTIVE in the request while performing lost/stolen on `newAccountNumber` | | 400 | REPLACEMENT_ACCOUNT_LOST_STOLEN | Replacement account is lost or stolen. | The replacement account is lost or stolen. Provide details related to a valid account. | | 400 | REPLACEMENT_ACCOUNT_INACTIVE_STATUS | Replacement account status is inactive. | Replacement account status should not be inactive. Update account status of new account. | | 400 | HOUSEHOLD_ID_MISMATCH | Replacement card number belongs to a multi-card household and it is not the same household of the previous card number. | Both old and new account should belong to same account group. Update account group or household details of new account. | | 400 | MULTIPLE_HOUSEHOLDS | Either the new household is the same as the previous household and the new card number belonged to more than 1 household, or, the new household is not the same as the previous household and the new card number belonged to more than two households. | Both old and new account should belong to same account group. Update account group or household details of new account. | | 400 | INVALID_PROGRAM | Replacement account is in a different program than the program for the previous account. | Both old and new account should belong to same program. Update program mapping of new account. | | 400 | DUPLICATE_CUSTOMER_ACCOUNT | Replacement account is already enrolled. Customer account has found a duplicate record with the same `BAN`, `BP`, and `CustomerId`. | Make sure the requested account's `BAN` and `bankProductId` do not already have a record for the same customer. If you are still seeing the issue, then work with your assigned regional manager or product delivery team for this configuration. | | 400 | HH_ELIGIBILITY_FAILED | Invalid customer or customer is already replaced. | Provide a valid newCustomerNumber in the request. If you are still seeing the issue, then work with your assigned regional manager or product delivery team for this configuration. | | 400 | CUSTOMER_NOT_FOUND | Customer not found. | Provide a valid newCustomerNumber(BCN) in the request. | | 400 | BANK_PRODUCT_NOT_FOUND | Bank product not found. | Old account does not have a valid bank product id. Update bank product mapping details for old account. | | 400 | LSWS_ERR_NEW_ACCT_ALREADY_REPL | Replacement account is already a replacement for a lost or stolen card. | Replacement account has already been used, provide a new valid replacement account. | | 400 | INVALID_CARD_NUMBER | Invalid card number. | Provide valid account details. | | 400 | LOST_STOLEN_FAILED | Unable to perform lost stolen. Check the `Details` field and contact the support team. | This error can be thrown for unknown reasons. Work with your assigned regional manager or product delivery team for this configuration. | ### POST /users/{id}/verifications {#post----usersidverifications} | HTTP Response Code | Reason Code | Description | Resolution Steps | |--------------------|---------------|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 400 | INVALID_INPUT | User verification failed. The verification answer provided is not valid. | Ensure that all verification answers provided are correct. | | 400 | INVALID_INPUT | Supported value for `userIdType` is `RANAC` or `RANCU`. | Check request parameter and ensure to provide RANAC or RANCU as `userIdType` parameter value. | | 400 | INVALID_INPUT | User verification details are missing or not valid. | Ensure that verification answer is not empty. | | 400 | INVALID_INPUT | Invalid date format. `Birthdate` is expected in 'yyyy-MM-dd' format. | Refer to the correct field value mentioned in the Verify User API Reference for correct field value mentioned here [VerifyUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#verify-user), and try again. | | 400 | INVALID_INPUT | User verification question code is not valid. | Refer to the correct field value mentioned in the Verify User API Reference for correct field value mentioned here [VerifyUser](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/user-management/index.md#verify-user), and try again. | | 400 | INVALID_INPUT | `UserVerificationDetails` can not be empty. | `UserVerificationDetails` must contain at least one verification question code and verification answer pair. | ### Account Identifiers {#account-identifiers} These codes apply to `POST /accounts/identifiers`, `PUT /accounts/identifiers`, and `POST /accounts/identifiers/searches`. See the [Account Identifiers](https://developer.mastercard.com/user-account-management-service/documentation/use-cases/account-identifiers/index.md) use case for the request flow. | Reason Code | Description | HTTP Response Code | Resolution Steps | |------------------------------------------------|-------------------------------------------------------------------------------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | INACTIVE_IDENTIFIER_TYPE | The identifier type exists but is inactive. | 400 | Activate the identifier type under **Global Settings → User Account Management → Identifiers**, save the changes, and try again. | | INACTIVE_IDENTIFIER_TYPE_PROGRAM | The identifier type exists globally but is inactive for the program. | 400 | Enable and activate the identifier type under **Company → Program → User Account Management → UAM Identifiers**, save the changes, and try again. | | INVALID_IDENTIFIER_TYPE | The system does not recognize the specified identifier type. | 400 | Define or activate the identifier type under **Global Settings → User Account Management → Identifiers** , then map and activate it under **Company → Program → User Account Management → UAM Identifiers**. Save the changes and try again. | | IDENTIFIER_IDENTIFIER_TYPE | The identifier type exists but is not linked to the program. | 400 | Map and activate the identifier type under **Company → Program → User Account Management → UAM Identifiers**, save the changes, and try again. | | INACTIVE_ACCOUNT | The customer account is inactive, so identifier operations are blocked. | 400 | Activate the customer account and try again. | | INVALID_IDENTIFIER_VALUE | The identifier value does not match the configured format. | 400 | Provide an identifier value that matches the configured numeric or alphanumeric format, and then try again. | | INVALID_IDENTIFIER_TYPE_ENTITY_CODE | The specified identifier type is not supported at the account level. | 400 | Use a valid account-level identifier type and try again. | | IDENTIFIER_VALUE_MAPPED_TO_DIFFERENT_ACCOUNT | The identifier value is already mapped to a different account. | 400 | Use a different identifier value or remove the existing mapping, and then try again. | | ACCOUNT_MAPPED_WITH_DIFFERENT_IDENTIFIER_VALUE | The account is already mapped to a different identifier value. | 400 | Review the existing mapping, use the correct identifier value, and then try again. | | IDENTIFIER_VALUE_MAPPED_TO_ACCOUNT | The identifier value is already mapped to the account. | 400 | Do not create the identifier again. Use the Update API to modify the existing identifier mapping. | | NO_ACTIVE_MAPPING | No active identifier mapping exists for the account. | 400 | Create the identifier using the Create (POST) API first, and then retry the update operation if required. | | IDENTIFIER_TYPE_MAPPED_TO_ACCOUNT | The identifier type is already mapped to the account, resulting in a duplicate identifier creation attempt. | 400 | Do not create the identifier again. Use a new identifier value or retain the existing mapping. | | INACTIVE_MAPPING | The identifier mapping exists but is inactive. | 400 | Activate the existing mapping or use a new active identifier, and then try again. | | NO_IDENTIFIERS_FOUND | No identifier was found for the specified account. | 400 | Verify that the identifier type and account ID are correct, and then try again. | | INVALID_ACCOUNT_ID | The account ID is missing or exceeds 100 characters. | 400 | Provide a non-empty account ID that is 100 characters or less, and then try again. | | INVALID_IDENTIFIER_TYPE | The identifier type is missing or exceeds 5 characters. | 400 | Provide a non-empty identifier type that is 5 characters or less, and then try again. | | INVALID_IDENTIFIER_VALUE | The identifier value is missing or exceeds 100 characters. | 400 | Provide a non-empty identifier value that is 100 characters or less, and then try again. | | INVALID_STATUS | The status value is invalid or exceeds the allowed length. | 400 | Use an allowed status value specified in the API reference and ensure that it meets the length requirements, and then try again. | | INVALID_ENTRY_DATE | The entry date is missing, has an invalid format, or does not meet the required length. | 400 | Provide the entry date in the required **YYYY-MM-DD** format and ensure that it meets the API's length requirements, and then try again. | | INVALID_EXIT_DATE | The exit date has an invalid format or is earlier than the entry date. | 400 | Provide the exit date in the required **YYYY-MM-DD** format and ensure that it is not earlier than the entry date, and then try again. | | INVALID_TITLE | The title exceeds the maximum allowed length of 40 characters. | 400 | Provide a title that is 40 characters or less, and then try again. | | INVALID_FIRST_NAME | The first name exceeds the maximum allowed length of 40 characters. | 400 | Provide a first name that is 40 characters or less, and then try again. | | INVALID_LAST_NAME | The last name exceeds the maximum allowed length of 40 characters. | 400 | Provide a last name that is 40 characters or less, and then try again. | | INVALID_SUFFIX | The suffix exceeds the maximum allowed length of 40 characters. | 400 | Provide a suffix that is 40 characters or less, and then try again. | ## Next Steps {#next-steps} * Diagnose common integration issues with the troubleshooting table on the [Testing](https://developer.mastercard.com/user-account-management-service/documentation/testing/index.md#troubleshooting) page. * Check request fields and allowed values in the [API Reference](https://developer.mastercard.com/user-account-management-service/documentation/api-reference/index.md). * If an error persists, see the [Support](https://developer.mastercard.com/user-account-management-service/documentation/support/index.md) FAQ or raise a request through [Get Help](https://developer.mastercard.com/user-account-management-service/documentation/support/index.md#get-help).