Error codes: customer management
Overview
This page provides comprehensive error code information for the Customer Management API, including error codes, descriptions, and resolution guidance based on actual codebase analysis.
Error response format
{
"errors": [
{
"code": 1213,
"message": "EntityName not allowed for classification"
}
]
}Error codes by category
Customer classification validation (1200-1225)
Validation errors related to customer profile and classification requirements.
Code | Description | Resolution |
|---|---|---|
1200 | DateFormed required | Include DateFormed field in the request for business entities |
1201 | DateFormed cannot be in the future | Provide a DateFormed date that is today or in the past |
1202 | BirthDate required | Include BirthDate field in the request for individual customers |
1203 | BirthDate cannot be in the future | Provide a BirthDate that is today or in the past |
1204 | EntityName required | Include EntityName field for business customers |
1205 | FirstName not allowed for classification | Remove FirstName field; not applicable to this customer classification |
1206 | MiddleName not allowed for classification | Remove MiddleName field; not applicable to this customer classification |
1207 | LastName not allowed for classification | Remove LastName field; not applicable to this customer classification |
1208 | Prefix not allowed for classification | Remove Prefix field; not applicable to this customer classification |
1209 | Suffix not allowed for classification | Remove Suffix field; not applicable to this customer classification |
1210 | PreferredName not allowed for classification | Remove PreferredName field; not applicable to this customer classification |
1211 | FirstName required | Include FirstName field in the request for individual customers |
1212 | LastName required | Include LastName field in the request for individual customers |
1213 | EntityName not allowed for classification | Remove EntityName field; only applicable to business customers |
1214 | Name required | Include customer name information (FirstName/LastName or EntityName based on classification) |
1215 | PoliticallyExposedPerson required | Include PoliticallyExposedPerson field for individual customers |
1216 | PoliticallyExposedPerson not allowed for classification | Remove PoliticallyExposedPerson field; only applicable to individual customers |
1217 | BirthDate not allowed for classification | Remove BirthDate field; only applicable to individual customers |
1218 | DateFormed not allowed for classification | Remove DateFormed field; only applicable to business entities |
1219 | RegO required | Include RegO (Regulation O) status for applicable customers |
1220 | RegO not allowed for classification | Remove RegO field; not applicable to this customer classification |
1221 | PrimaryOwnerCustomerId required | Include PrimaryOwnerCustomerId for entity customers |
1222 | PrimaryOwnerCustomerId not allowed for classification | Remove PrimaryOwnerCustomerId; only applicable to entity customers |
1223 | EntityType not allowed for classification | Remove EntityType field; not applicable to this customer classification |
1224 | OwnershipType not allowed for classification | Remove OwnershipType field; not applicable to this customer classification |
1225 | TaxIdType not allowed for classification | Remove TaxIdType field; not applicable to this customer classification |
Customers (2200-2226)
Errors related to customer profile management and relationships.
Code | Description | Resolution |
|---|---|---|
2200 | Customer not found | Verify the customer ID is correct; check if customer exists using GET /customers/{id} |
2201 | Customer not active | Customer must be in active status for this operation |
2202 | Entity not active | Entity customer must be active for this operation |
2203 | Address not active | Address must be in active status; verify address status |
2204 | Cannot remove primary address | Mark a different address as primary before removing this address |
2205 | DateFormed required | Include DateFormed field for business entities |
2206 | DateFormed cannot be in the future | Provide a DateFormed date that is today or in the past |
2207 | BirthDate required | Include BirthDate field for individual customers |
2208 | BirthDate cannot be in the future | Provide a BirthDate that is today or in the past |
2209 | Primary owner customer not found | Verify primary owner customer ID is correct and customer exists |
2210 | Primary owner customer not active | Primary owner customer must be active |
2211 | Primary owner customer must be a person | Primary owner must be an individual customer, not a business entity |
2212 | Entity and primary owner must be under same partner | Ensure entity and primary owner are both associated with the same partner |
2213 | Entity and primary owner must be different customers | Primary owner cannot be the same as the entity customer |
2214 | Entity customer must be a business | Entity classification requires business customer type |
2215 | Owner customer not found | Verify owner customer ID is correct and customer exists |
2216 | Owner customer not active | Owner customer must be active |
2217 | Owner customer must be a person | Owner must be an individual customer, not a business entity |
2218 | Entity and owner customers must be under same partner | Ensure entity and owner are both associated with the same partner |
2219 | Entity and owner must be different customers | Owner cannot be the same as the entity customer |
2220 | Owner relationship already exists for entity customer | This owner relationship already exists; cannot create duplicate |
2221 | Unable to deactivate customer due to established account relationship(s) | Remove or deactivate all account relationships before deactivating customer |
2222 | Partner not found or is inactive | Verify partner ID is correct and partner is active |
2223 | An active customer with this tax ID already exists for partner | Active customer with this tax ID already exists; use existing customer or provide different tax ID |
2224 | Cannot remove primary identification | Mark a different identification as primary before removing this one |
2225 | Cannot remove primary phone | Mark a different phone number as primary before removing this one |
2226 | Invalid customer entity type | Provide a valid customer entity type |
Relationships (2525-2534)
Errors related to customer-account relationship management.
Error Code | Description | Resolution |
|---|---|---|
2525 | Relationship not found | Verify the relationship ID is correct; check if relationship exists |
2526 | Relationship not active | Relationship must be active for this operation |
2527 | Primary relationship cannot be removed | Mark a different relationship as primary before removing this one |
2528 | Relationship not allowed for account type | This relationship type is not permitted for this account type |
2529 | RelationshipType not allowed for account classification | This relationship type is not permitted for this account classification |
2530 | IsTaxReportingOwner cannot be enabled for relationship type | Tax reporting owner flag is not supported for this relationship type |
2531 | Customer must be classified as a person | This operation requires an individual customer, not a business entity |
2532 | Customer relationship already exists | Relationship between this customer and account already exists |
2533 | Customer must be under same partner as account | Ensure customer and account belong to the same partner |
2534 | Customer must be cleared for OFAC prior to creating relationship | Complete OFAC screening before creating account relationship |