{ "openapi": "3.1.2", "info": { "version": "1.0.0", "title": "Customer Search", "description": "This is an OpenAPI Specification for APIs that provide unified customer identity and account search.", "contact": { "name": "Omni API Support", "email": "DL-OmniAdapter@att.com" } }, "servers": [ { "url": "https://partner.att.com/omni-svcs" } ], "security": [], "tags": [ { "name": "Customer Search", "description": "Omni Customer Search" } ], "paths": { "/v1/customers/search": { "post": { "tags": [ "Customer Search" ], "description": "Returns Customers associated individuals, and account information.", "summary": "Search customers by identity and account attributes", "operationId": "CustomerSearch", "parameters": [ { "$ref": "#/components/parameters/ParameterAppname" } ], "requestBody": { "description": "Customer search request payload", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSearchRequest" }, "examples": { "searchFiberConsumerCustomerByAccountIdAndServiceType": { "summary": "Search fiber consumer customer by account ID and service type", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer" ], "value": { "accountId": "556270421633", "serviceType": "FIBER", "pageSize": 5, "pageOffset": 1 } }, "searchFiberCustomerByNamePhoneEmail": { "summary": "Search fiber customer by name phone email", "description": "Search fiber customer by first name, last name, phone number, and email address", "x-tags": [ "Fiber-Move-Consumer", "Fiber-Change-Consumer" ], "value": { "firstName": "ellsworth", "lastName": "denesik", "phoneNumber": "6143194370", "emailAddress": "ellsworth.denesik@att.com", "serviceType": "FIBER" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSearchResponse" }, "examples": { "FiberConsumerSearchResponse": { "summary": "Fiber consumer search by ban service type response with all individual fields", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer" ], "value": { "totalCount": 1, "pageInfo": { "pageSize": 5, "pageOffset": 1 }, "individuals": [ { "id": "6c4d273d-a000-4e2e-a885-c7b4e09a0f1a", "givenName": "ellsworth", "familyName": "denesik", "profile": { "firstName": "ellsworth", "lastName": "denesik", "emailAddress": "ellsworth.denesik@att.com", "phoneNumber": "6143194370" }, "status": "initialized", "createdOn": "2026-01-02T19:49:43.935Z", "updatedOn": "2026-01-02T19:49:43.935Z", "relatedAccounts": [ { "accountId": "556270421633", "role": "owner", "customerId": "44e6c283-d93b-4819-b432-b27bf33c0354" } ], "accounts": [ { "id": "556270421633", "accountType": "I", "accountSubType": "R", "ratingType": "postpaid", "serviceType": "fiber", "targetSOR": "CG", "createdOn": "2024-11-05T22:08:59.871Z", "lastModified": "2026-01-02T19:50:32.991Z", "openDate": "2024-11-05T22:08:59.871Z", "isDigitalAccount": true, "state": { "state": "active", "stateChangeReason": [ { "name": "NS-NEW", "date": "2026-01-02T19:50:32.991Z" } ] }, "subscribers": [ { "id": "556270421633", "products": [ { "productOfferingTypeGroup": "BBOffer", "id": "910776520116902", "isBundle": true, "productOfferingClassification": "subscriberMainOffer", "rootProductId": "910776520116902", "productOfferingId": "b0a87cda-8d42-4ca2-a63c-511f6787c64e", "name": "TestOnly_Fiber 5G Package", "description": "TestOnly Fiber 5G Package", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2024-11-05T22:08:59.871Z" } ] }, "activationDate": "2024-11-05T22:08:59.871Z", "creationDate": "2024-11-05T22:09:03Z", "lastUpdate": "2024-12-04T12:30:30Z", "place": [ { "id": "00000CSNFC", "name": "ServiceAddress", "role": "SA" }, { "id": "00000CSNFC", "name": "InstallationAddress", "role": "installation" } ], "productCharacteristic": [ { "name": "Auto_Pay_Enrollment", "value": "Y", "valueType": "String" }, { "name": "TenderType", "value": "ACH", "valueType": "String" }, { "name": "billingProfile", "value": "hassleFree", "valueType": "String" }, { "name": "Payment_Type", "value": "Pay_on_Bill", "valueType": "String" }, { "name": "productType", "value": "FIBER", "valueType": "String" } ] }, { "productOfferingTypeGroup": "BBPlan", "id": "65201191077001186", "isBundle": false, "productOfferingClassification": "subscriberOffer", "rootProductId": "910776520116902", "productOfferingId": "f890ca78-968d-457a-b6d6-fbc0553095f3", "name": "TestOnly_Fiber 5G Plan", "description": "TestOnly Fiber 5G Plan", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2024-11-05T22:08:59.871Z" } ] }, "activationDate": "2024-11-05T22:08:59.871Z", "creationDate": "2024-11-05T22:08:59.871Z", "lastUpdate": "2024-11-05T22:08:59.871Z", "place": [ { "id": "00000CSNFC", "name": "ServiceAddress", "role": "SA" }, { "id": "00000CSNFC", "name": "InstallationAddress", "role": "installation" } ], "productCharacteristic": [ { "name": "Speed", "value": "5000", "valueType": "String", "characteristicMetadata": [ { "name": "Visible", "value": "True", "metadataType": "Configuration" }, { "name": "serviceabilityParameterName", "value": "Speed", "metadataType": "Location and Serviceability" } ] }, { "name": "billingProfile", "value": "hassleFree", "valueType": "String" }, { "name": "Payment_Type", "value": "Pay_on_Bill", "valueType": "String" }, { "name": "productType", "value": "FIBER", "valueType": "String" } ] }, { "productOfferingTypeGroup": "equipment", "id": "76012869102489446", "isBundle": false, "productOfferingClassification": "customerOffer", "rootProductId": "910776520116902", "productOfferingId": "d540cf2a-23ff-4ff6-b859-53c5f1985476", "name": "Fiber Hub", "description": "Fiber Converged Equipment", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2026-01-02T13:50:29.791Z" } ] }, "activationDate": "2026-01-02T13:50:29.791Z", "creationDate": "2026-01-02T13:50:29.791Z", "lastUpdate": "2026-01-02T13:50:29.791Z", "place": [ { "id": "000025OLUK", "name": "ServiceAddress", "role": "SA" }, { "id": "000025OLUK", "name": "InstallationAddress", "role": "installation" } ], "productCharacteristic": [ { "name": "SKU_With_Prefix", "value": "RTL.207AA", "valueType": "String" }, { "name": "Sub_Group", "value": "HUB_F1", "valueType": "String" }, { "name": "Delivery_Method", "value": "Indirect_Delivery_Shipping", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "deliveryMethod", "metadataType": "General" } ] }, { "name": "Installation_Method", "value": "Self_Installation", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "installing", "metadataType": "General" } ] }, { "name": "Return_Method", "value": "Return_by_box_Shipment", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "returned", "metadataType": "General" } ] }, { "name": "Recoverable_Disconnect", "value": "RECOVERABLE", "valueType": "String" }, { "name": "Available_Shipping_Options", "value": "Standard_Post", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "availableShippingOptions", "metadataType": "General" } ] }, { "name": "Purchase_Option", "value": "Rent", "valueType": "String" }, { "name": "Return_Shipment_Option", "value": "Standard_Post", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "shippedBack", "metadataType": "General" } ] }, { "name": "buyersRemorseDuration", "value": "31", "valueType": "String" }, { "name": "productType", "value": "FIBER", "valueType": "String" }, { "name": "billingProfile", "value": "hassleFree", "valueType": "String" }, { "name": "Payment_Type", "value": "Pay_on_Bill", "valueType": "String" } ] } ] } ] } ] } ] } }, "FiberConsumerByNamePhoneEmailSearchResponse": { "summary": "Fiber consumer search response By Name Phone Email with all individual fields", "x-tags": [ "Fiber-Move-Consumer", "Fiber-Change-Consumer" ], "value": { "totalCount": 1, "pageInfo": { "pageSize": 5, "pageOffset": 1 }, "individuals": [ { "id": "6c4d273d-a000-4e2e-a885-c7b4e09a0f1a", "givenName": "ellsworth", "familyName": "denesik", "profile": { "firstName": "ellsworth", "lastName": "denesik", "emailAddress": "ellsworth.denesik@att.com", "phoneNumber": "6143194370" }, "status": "initialized", "createdOn": "2026-01-02T19:49:43.935Z", "updatedOn": "2026-01-02T19:49:43.935Z", "relatedAccounts": [ { "accountId": "556270421633", "role": "owner", "customerId": "44e6c283-d93b-4819-b432-b27bf33c0354" } ], "accounts": [ { "id": "556270421633", "accountType": "I", "accountSubType": "R", "ratingType": "postpaid", "serviceType": "fiber", "targetSOR": "CG", "createdOn": "2024-11-05T22:08:59.871Z", "lastModified": "2026-01-02T19:50:32.991Z", "openDate": "2024-11-05T22:08:59.871Z", "isDigitalAccount": true, "state": { "state": "active", "stateChangeReason": [ { "name": "NS-NEW", "date": "2026-01-02T19:50:32.991Z" } ] }, "subscribers": [ { "id": "556270421633", "products": [ { "productOfferingTypeGroup": "BBOffer", "id": "910776520116902", "isBundle": true, "productOfferingClassification": "subscriberMainOffer", "rootProductId": "910776520116902", "productOfferingId": "b0a87cda-8d42-4ca2-a63c-511f6787c64e", "name": "TestOnly_Fiber 5G Package", "description": "TestOnly Fiber 5G Package", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2024-11-05T22:08:59.871Z" } ] }, "activationDate": "2024-11-05T22:08:59.871Z", "creationDate": "2024-11-05T22:09:03Z", "lastUpdate": "2024-12-04T12:30:30Z", "place": [ { "id": "00000CSNFC", "name": "ServiceAddress", "role": "SA" }, { "id": "00000CSNFC", "name": "InstallationAddress", "role": "installation" } ], "productCharacteristic": [ { "name": "Auto_Pay_Enrollment", "value": "Y", "valueType": "String" }, { "name": "TenderType", "value": "ACH", "valueType": "String" }, { "name": "billingProfile", "value": "hassleFree", "valueType": "String" }, { "name": "Payment_Type", "value": "Pay_on_Bill", "valueType": "String" }, { "name": "productType", "value": "FIBER", "valueType": "String" } ] }, { "productOfferingTypeGroup": "BBPlan", "id": "65201191077001186", "isBundle": false, "productOfferingClassification": "subscriberOffer", "rootProductId": "910776520116902", "productOfferingId": "f890ca78-968d-457a-b6d6-fbc0553095f3", "name": "TestOnly_Fiber 5G Plan", "description": "TestOnly Fiber 5G Plan", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2024-11-05T22:08:59.871Z" } ] }, "activationDate": "2024-11-05T22:08:59.871Z", "creationDate": "2024-11-05T22:08:59.871Z", "lastUpdate": "2024-11-05T22:08:59.871Z", "place": [ { "id": "00000CSNFC", "name": "ServiceAddress", "role": "SA" }, { "id": "00000CSNFC", "name": "InstallationAddress", "role": "installation" } ], "productCharacteristic": [ { "name": "Speed", "value": "5000", "valueType": "String", "characteristicMetadata": [ { "name": "Visible", "value": "True", "metadataType": "Configuration" }, { "name": "serviceabilityParameterName", "value": "Speed", "metadataType": "Location and Serviceability" } ] }, { "name": "billingProfile", "value": "hassleFree", "valueType": "String" }, { "name": "Payment_Type", "value": "Pay_on_Bill", "valueType": "String" }, { "name": "productType", "value": "FIBER", "valueType": "String" } ] }, { "productOfferingTypeGroup": "equipment", "id": "76012869102489446", "isBundle": false, "productOfferingClassification": "customerOffer", "rootProductId": "910776520116902", "productOfferingId": "d540cf2a-23ff-4ff6-b859-53c5f1985476", "name": "Fiber Hub", "description": "Fiber Converged Equipment", "status": { "status": "active", "statusChangeReason": [ { "name": "NS-NEW", "date": "2026-01-02T13:50:29.791Z" } ] }, "activationDate": "2026-01-02T13:50:29.791Z", "creationDate": "2026-01-02T13:50:29.791Z", "lastUpdate": "2026-01-02T13:50:29.791Z", "place": [ { "id": "000025OLUK", "name": "ServiceAddress", "role": "SA" }, { "id": "000025OLUK", "name": "InstallationAddress", "role": "installation" } ], "productCharacteristic": [ { "name": "SKU_With_Prefix", "value": "RTL.207AA", "valueType": "String" }, { "name": "Sub_Group", "value": "HUB_F1", "valueType": "String" }, { "name": "Delivery_Method", "value": "Indirect_Delivery_Shipping", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "deliveryMethod", "metadataType": "General" } ] }, { "name": "Installation_Method", "value": "Self_Installation", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "installing", "metadataType": "General" } ] }, { "name": "Return_Method", "value": "Return_by_box_Shipment", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "returned", "metadataType": "General" } ] }, { "name": "Recoverable_Disconnect", "value": "RECOVERABLE", "valueType": "String" }, { "name": "Available_Shipping_Options", "value": "Standard_Post", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "availableShippingOptions", "metadataType": "General" } ] }, { "name": "Purchase_Option", "value": "Rent", "valueType": "String" }, { "name": "Return_Shipment_Option", "value": "Standard_Post", "valueType": "String", "characteristicMetadata": [ { "name": "businessType", "value": "shippedBack", "metadataType": "General" } ] }, { "name": "buyersRemorseDuration", "value": "31", "valueType": "String" }, { "name": "productType", "value": "FIBER", "valueType": "String" }, { "name": "billingProfile", "value": "hassleFree", "valueType": "String" }, { "name": "Payment_Type", "value": "Pay_on_Bill", "valueType": "String" } ] } ] } ] } ] } ] } } } } } }, "400": { "description": "Bad request - Missing fields, Invalid input data, validation failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "MissingSearchParameters": { "summary": "Missing search parameters", "value": { "error": { "errorId": "EXT_CUSTOMER_SEARCH-CG-0001", "message": "No search parameters provided. At least one search parameter combination must be supplied in the request.", "errorSystemId": "extpartnercustmgmtms", "details": [ { "code": "MISSING_SEARCHPARAMETERS", "message": "At least one search parameter combination must be provided." } ] } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "CustomerSearchSystemError": { "summary": "System Error", "value": { "error": { "errorId": "EXT_CUSTOMER_SEARCH-CG-500", "message": "System Error", "errorSystemId": "Customer Search", "details": [ { "code": "INTERNAL_SERVER", "message": "Unexpected server error occurred during processing. Please try again later." } ] } } } } } } } } } } }, "components": { "schemas": { "CustomerSearchRequest": { "type": "object", "description": "Search criteria to filter individuals and associated accounts.", "properties": { "accountId": { "type": "string", "description": "Unique billing account identifier (BAN or account number)." }, "firstName": { "type": "string", "description": "Customer first name." }, "lastName": { "type": "string", "description": "Customer last name." }, "phoneNumber": { "type": "string", "description": "Customer contact number, CTN, or CBR." }, "emailAddress": { "type": "string", "description": "Customer email address." }, "serviceType": { "$ref": "#/components/schemas/ServiceType", "description": "Type of service associated with the customer." }, "pageSize": { "type": "integer", "format": "int32", "description": "Number of results to return per page.", "default": 5, "minimum": 1 }, "pageOffset": { "type": "integer", "format": "int32", "description": "Offset for pagination. Starts at 1.", "default": 1, "minimum": 1 }, "productOfferingId": { "type": "string", "description": "Product offering identifier used to refine the customer product offering results." }, "topic": { "type": "array", "description": "Topics defining the data to retrieve. Defaults to individuals when not provided.", "items": { "type": "string", "enum": [ "individuals", "accounts", "subscribers", "products", "equipments", "addons", "contracts", "installments" ] } } } }, "CustomerSearchResponse": { "type": "object", "properties": { "individuals": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "totalCount": { "type": "integer", "format": "int32" } } }, "PageInfo": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32" }, "pageOffset": { "type": "integer", "format": "int32" } } }, "Individual": { "type": "object", "properties": { "id": { "type": "string" }, "givenName": { "type": "string" }, "familyName": { "type": "string" }, "preferredName": { "type": "string" }, "contactMedium": { "type": "array", "description": "Contact mediums for the individual including addresses and phone numbers.", "items": { "type": "object", "properties": { "mediumType": { "type": "string", "description": "Type of contact medium (e.g., 'email', 'phone numbers', 'addresses')." }, "preferred": { "type": "boolean", "description": "Whether this is the preferred contact medium." }, "characteristic": { "type": "object", "description": "Contact medium characteristics.", "properties": { "stateOrProvince": { "type": "string", "description": "State or province." }, "postCode": { "type": "string", "description": "Postal code." }, "street1": { "type": "string", "description": "Primary street address." }, "street2": { "type": "string", "description": "Secondary street address." }, "city": { "type": "string", "description": "City name." }, "country": { "type": "string", "description": "Country name." }, "place": { "type": "object", "properties": { "id": { "type": "string", "description": "Place identifier." } } }, "contactType": { "type": "string", "description": "Phone contact type (e.g., 'other', 'work', 'telephone')." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "emailAddress": { "type": "string", "description": "Email address." } } } } } }, "relatedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAccount" } }, "profile": { "$ref": "#/components/schemas/Profile" }, "status": { "type": "string" }, "createdOn": { "type": "string" }, "updatedOn": { "type": "string" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, "RelatedAccount": { "type": "object", "properties": { "accountId": { "type": "string" }, "role": { "type": "string" }, "customerId": { "type": "string" } } }, "Profile": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleInitial": { "type": "string" }, "emailAddress": { "type": "string" }, "phoneNumber": { "type": "string" } } }, "ServiceType": { "type": "string", "enum": [ "WIRELESS", "UVERSE", "WIRELESSBROADBAND", "FIBER" ] }, "ProductCustomerSearch": { "type": "object", "description": "Product resource for unified customer search.", "properties": { "productOfferingTypeGroup": { "type": "string", "description": "Product offering type group." }, "id": { "type": "string", "description": "Unique product identifier." }, "isBundle": { "type": "boolean", "description": "Indicates whether the product is a bundle." }, "productOfferingClassification": { "type": "string", "description": "Product offering classification." }, "rootProductId": { "type": "string", "description": "Root product identifier." }, "productOfferingId": { "type": "string", "description": "Product offering identifier." }, "name": { "type": "string", "description": "Product name." }, "productCode": { "type": "string", "description": "Product code." }, "description": { "type": "string", "description": "Product description." }, "status": { "type": "object", "description": "Current product status details.", "additionalProperties": true, "properties": { "status": { "type": "string", "description": "Current lifecycle state value." }, "statusCode": { "type": "string", "description": "Product status code." }, "statusChangeReason": { "type": "array", "description": "History of reasons associated with product state transitions.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reason name." }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the reason was recorded." }, "description": { "type": "string", "description": "Reason description." }, "activity": { "type": "string", "description": "Associated activity that triggered the state change." } }, "additionalProperties": true } } } }, "activationDate": { "type": "string", "format": "date-time", "description": "Product activation date and time." }, "creationDate": { "type": "string", "format": "date-time", "description": "Product creation date." }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Timestamp when the product record was last updated." }, "place": { "type": "array", "description": "Places associated with the product.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique place identifier." }, "name": { "type": "string", "description": "Place name." }, "role": { "type": "string", "description": "Place role." } } } }, "productCharacteristic": { "type": "array", "description": "Characteristics associated with the product.", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Characteristic name." }, "value": { "type": "string", "description": "Characteristic value." } } } }, "terminationDate": { "type": "string", "format": "date-time", "description": "Timestamp when the product was terminated." } } }, "Subscriber": { "type": "object", "description": "Subscriber resource for unified customer search.", "properties": { "id": { "type": "string", "description": "Unique subscriber identifier." }, "phoneNumber": { "type": "string", "description": "Subscriber phone number (CTN/MSISDN)." }, "profile": { "type": "object", "description": "Subscriber profile name information.", "properties": { "firstName": { "type": "string", "description": "Subscriber first name." }, "lastName": { "type": "string", "description": "Subscriber last name." } } }, "contactMedium": { "type": "array", "description": "Contact mediums for the subscriber including addresses and phone numbers.", "items": { "type": "object", "properties": { "mediumType": { "type": "string", "description": "Type of contact medium (e.g., 'email', ' phone numbers', 'addresses')." }, "preferred": { "type": "boolean", "description": "Whether this is the preferred contact medium." }, "characteristic": { "type": "object", "description": "Contact medium characteristics.", "properties": { "stateOrProvince": { "type": "string", "description": "State or province." }, "postCode": { "type": "string", "description": "Postal code." }, "street1": { "type": "string", "description": "Primary street address." }, "street2": { "type": "string", "description": "Secondary street address." }, "city": { "type": "string", "description": "City name." }, "country": { "type": "string", "description": "Country name." }, "contactType": { "type": "string", "description": "Phone contact type (e.g., 'other', 'work', 'telephone')." }, "place": { "type": "object", "properties": { "id": { "type": "string", "description": "Place identifier." } } }, "phoneNumber": { "type": "string", "description": "Phone number." }, "emailAddress": { "type": "string", "description": "Email address." } } } } } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the subscriber record was created." }, "updatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the subscriber record was last updated." }, "activationDate": { "type": "string", "format": "date-time", "description": "Subscriber activation date and time." }, "effectiveDate": { "type": "string", "format": "date-time", "description": "Effective date and time for current subscriber state." }, "subMarket": { "type": "string", "description": "Subscriber submarket code." }, "status": { "type": "object", "description": "Subscriber status details.", "properties": { "status": { "type": "string", "description": "Current lifecycle state value." }, "statusChangeReason": { "type": "array", "description": "History of reasons associated with subscriber state transitions.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reason name." }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the reason was recorded." }, "description": { "type": "string", "description": "Reason description." } } } } } }, "products": { "type": "array", "description": "Products associated with the subscriber.", "items": { "$ref": "#/components/schemas/ProductCustomerSearch" } } } }, "Account": { "type": "object", "description": "Account resource for unified customer search.", "properties": { "id": { "type": "string", "description": "Unique account identifier." }, "givenName": { "type": "string", "description": "Given name of the account holder." }, "familyName": { "type": "string", "description": "Family name of the account holder." }, "title": { "type": "string", "description": "Title of the account holder (for example, Mr, Ms, or Dr)." }, "middleInitial": { "type": "string", "description": "Middle initial of the account holder." }, "accountType": { "type": "string", "description": "Primary account type classification." }, "accountSubType": { "type": "string", "description": "Secondary account type classification." }, "ratingType": { "type": "string", "description": "Rating category used for billing and charging." }, "serviceType": { "type": "string", "description": "Line-of-business service type (for example, wireless, fiber, or U-verse)." }, "targetSOR": { "type": "string", "description": "Target SOR (System of Record) for this account." }, "subscribersCount": { "type": "string", "description": "Number of subscribers linked to the account, represented as a source string." }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the account record was created." }, "lastModified": { "type": "string", "format": "date-time", "description": "Timestamp when the account record was last modified." }, "openDate": { "type": "string", "format": "date-time", "description": "Date and time when the account became active." }, "billingMarket": { "type": "string", "description": "Billing market code for the account." }, "billingSubMarket": { "type": "string", "description": "Billing submarket code for the account." }, "accountLocked": { "type": "string", "description": "Indicates whether the account is locked and, if applicable, the lock state." }, "autoBillPayIndicator": { "type": "string", "description": "Indicates the auto-bill pay status of the account." }, "bill": { "type": "object", "description": "Billing information for the account.", "properties": { "billStructure": { "type": "object", "description": "Structure of the bill including presentation and cycle details.", "properties": { "presentationMedia": { "type": "object", "description": "Presentation media for the bill.", "properties": { "name": { "type": "string", "description": "Name of the presentation media (e.g., paperless)." } } }, "cycleSpecification": { "type": "object", "description": "Billing cycle specification details.", "properties": { "id": { "type": "string", "description": "Identifier of the billing cycle specification." }, "name": { "type": "string", "description": "Name of the billing cycle specification." }, "frequency": { "type": "string", "description": "Frequency of the billing cycle (e.g., month)." } } } } }, "billCycleStartDay": { "type": "string", "description": "Day of the month when the bill cycle starts." }, "billCycleEndDay": { "type": "string", "description": "Day of the month when the bill cycle ends." }, "nextBillCycleStartDay": { "type": "string", "description": "Day of the month when the next bill cycle starts." }, "noOfDaysLeftInCurrentBillCycle": { "type": "string", "description": "Number of days remaining in the current bill cycle." }, "billDueDate": { "type": "string", "description": "Due date for the bill payment." }, "isPaperlessBill": { "type": "string", "description": "Indicates whether the bill is paperless." }, "lastBillCycleEndDate": { "type": "string", "description": "End date of the last bill cycle." }, "lastBillTotalAmount": { "type": "string", "description": "Total amount of the last bill." } } }, "state": { "type": "object", "description": "Lifecycle state information for the account.", "properties": { "state": { "type": "string", "description": "Current lifecycle state value." }, "stateChangeReason": { "type": "array", "description": "History of reasons associated with account state transitions.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reason name." }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the reason was recorded." }, "description": { "type": "string", "description": "Reason description." }, "activity": { "type": "string", "description": "Associated activity that triggered the state change." } } } } } }, "isDigitalAccount": { "type": "boolean", "description": "Indicates whether this account is marked as digital." }, "languagePreference": { "type": "string", "description": "Preferred language for account communications." }, "smbContact": { "type": "object", "description": "SMB (Small and Medium Business) contact details.", "properties": { "firstName": { "type": "string", "description": "First name of the SMB contact." }, "lastName": { "type": "string", "description": "Last name of the SMB contact." } } }, "extensions": { "type": "object", "description": "Extension attributes for the account.", "properties": { "businessType": { "type": "string", "description": "Business type classification of the account holder." }, "enterpriseType": { "type": "string", "description": "Enterprise type classification of the account." }, "migrationIndicator": { "type": "string", "description": "Indicates the migration status of the account." }, "migrationAccountLock": { "type": "string", "description": "Indicates the migration account lock status." }, "customerSubType": { "type": "string", "description": "Customer sub-type classification." }, "customerType": { "type": "string", "description": "Customer type classification." }, "fiberProvider": { "type": "string", "description": "Fiber service provider name." }, "isEmployee": { "type": "string", "description": "Indicates whether the account holder is an employee." }, "suspensionStatus": { "type": "string", "description": "Current suspension status of the account." }, "voluntarySuspensionStatus": { "type": "string", "description": "Voluntary suspension status of the account." }, "voluntarySuspensionReason": { "type": "string", "description": "Reason for the voluntary suspension." }, "convergedCustomerOption": { "type": "string", "description": "Converged customer option code." }, "convergedCustomerOptionDisplay": { "type": "string", "description": "Display value for the converged customer option." }, "wirelessAccountLock": { "type": "string", "description": "Indicates the wireless account lock status." }, "walUpdatedBy": { "type": "string", "description": "Identifier of who last updated the wireless account lock." }, "unifiedBan": { "type": "string", "description": "Unified billing account number." }, "uverseCombinedBillBan": { "type": "string", "description": "U-verse combined bill billing account number." }, "digitalCustomer": { "type": "string", "description": "Indicates whether the customer is a digital customer." }, "instantHSIAOnIndicator": { "type": "string", "description": "Indicates whether instant HSIA (High Speed Internet Access) is enabled." } } }, "subscribers": { "description": "List of subscribers associated with this account.", "type": "array", "items": { "$ref": "#/components/schemas/Subscriber" } } } }, "PartnerServiceError": { "type": "object", "properties": { "errorId": { "type": "string", "example": "Top level error code" }, "message": { "type": "string", "example": "Top level error message" }, "errorSystemId": { "type": "string", "example": "System name" }, "details": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "Detail code 1" }, "message": { "type": "string", "example": "Detail message 1" } } } } } }, "WrappedPartnerServiceError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/PartnerServiceError" } } } }, "parameters": { "ParameterAppname": { "name": "appname", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Application name making the request" } } } }