openapi: 3.0.1 info: title: MTN TMF632 Party Management description: "This service provides comprehensive party management capabilities\ \ for MTN customers including individual and organization management, credit information,\ \ and partner services. It serves as the service layer for all TMF632 party-related\ \ operations across the MTN ecosystem." license: name: MADAPI url: https://developers.mtn.com/ version: 3.0.0 - Last updated date:2026-09-17 10:21:06 servers: - url: https://api.mtn.com/v1 description: Production Server security: - OAuth2: [] tags: - name: TMF632 Party Management paths: /credit-info: post: tags: - TMF632 Party Management summary: Post Credit Information description: This operation posts credit information to the CRC system for party management. The endpoint validates target system requirements and processes credit information requests with proper transaction tracking and system endpoint routing. operationId: PartyManagementService_post_postCreditInfo_creditinfo parameters: - name: countryCode in: header required: false schema: type: string - name: requestType in: header required: true schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: true schema: type: string requestBody: content: application/json: schema: title: CreditInfoRequest type: object properties: creditInfo: type: array items: title: CreditInfo type: object properties: customerId: type: string branchCode: type: string lastName: type: string firstName: type: string middleName: type: string dateOfBirth: type: string nationalIdentityNumber: type: string driversLicense: type: string BVN: type: string passportNo: type: string gender: type: string nationality: type: string maritalStatus: type: string phoneNumberOne: type: string primaryAddressOne: type: string primaryAddressTwo: type: string countryLgaOne: type: string countryStateOne: type: string countryOne: type: string employmentStatus: type: string occupation: type: string businessCategory: type: string businessSector: type: string BorrowerType: type: string otherID: type: string taxID: type: string pictureFilePath: type: string emailAddress: type: string employerName: type: string employerAddressOne: type: string employerAddressTwo: type: string employerLga: type: string employerState: type: string employerCountry: type: string title: type: string placeOfBirth: type: string phoneNumberTwo: type: string phoneNumberThree: type: string secondaryAddressOne: type: string secondaryAddressTwo: type: string secondaryAddressLga: type: string secondaryAddressState: type: string secondaryAddressCountry: type: string spousesLastName: type: string spousesFirstName: type: string spousesMiddleName: type: string businessInfo: title: BusinessInfo type: object properties: Id: type: string name: type: string type: type: string category: type: string dateOfIncorporation: type: string customerId: type: string branchCode: type: string contactMedium: type: array items: title: ContactMediumOne type: object properties: addressOne: type: string addressTwo: type: string lga: type: string state: type: string preferred: type: boolean country: type: string guarantorInfo: type: array items: title: GuarantorInfo type: object properties: corporateName: type: string bizID: type: string lastName: type: string firstname: type: string middleName: type: string date: type: string gender: type: string nationalID: type: string passportNo: type: string driversLicence: type: string BVN: type: string otherID: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string phoneNumber: type: string emailAddress: type: string creditInfo: title: CreditRecord type: object properties: dateOfLoan: type: string creditLimit: type: string availedLimit: type: string outstandingBalance: type: string installmentAmount: type: string currency: type: string daysInArrears: type: string overDueAmount: type: string loanType: type: string loanTenor: type: string repaymentFrequency: type: string lastPaymentDate: type: string lastPaymentAmount: type: string maturityDate: type: string loanClassification: type: string legalChallengeStatus: type: string litigationDate: type: string consentStatus: type: string loanSecurityStatus: type: string collateralType: type: string collateralDetails: type: string previousAccountNumber: type: string previousName: type: string previousCustomerId: type: string previousBranchCode: type: string principalInfo: type: array items: title: PrincipalInfo type: object properties: lastName: type: string firstName: type: string middleName: type: string dateOfBirth: type: string gender: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string nationalId: type: string driversLicence: type: string BVN: type: string passportNo: type: string phoneNumber: type: string email: type: string designation: type: string loanStatus: type: string guaranteeType: type: string accountNumber: type: string accountStatus: type: string accountStatusDate: type: string taxId: type: string dateOfLoan: type: string creditLimit: type: string availedLimit: type: string outstandingBalance: type: string installmentAmount: type: string currency: type: string daysInArrears: type: string overDueAmount: type: string loanType: type: string loanTenor: type: string repaymentFrequency: type: string lastPaymentDate: type: string lastPaymentAmount: type: string maturityDate: type: string loanClassification: type: string legalChallengeStatus: type: string litigationDate: type: string consentStatus: type: string loanSecurityStatus: type: string collateralType: type: string collateralDetails: type: string previousAccountNumber: type: string previousName: type: string previousCustomerId: type: string previousBranchCode: type: string userId: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: CRCResponse type: object properties: transactionId: type: string timestamp: type: string status: type: string error: type: string message: type: string result: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_Result' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /individual: get: tags: - TMF632 Party Management summary: Get Individual Entity description: This operation retrieves an Individual entity with comprehensive attribute selection enabled for all first level attributes. The endpoint supports filtering and field selection to optimize data retrieval based on specific requirements. operationId: PartyManagementService_get_getIndividual_individual parameters: - name: callBackUrl in: header required: false schema: type: string - name: fields in: query required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-authorization in: header required: false schema: type: string - name: x-country-code in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: IndividualResponseData type: object properties: id: type: string href: type: string aristocraticTitle: type: string birthDate: type: string countryOfBirth: type: string deathDate: type: string firstName: type: string middleName: type: string lastName: type: string familyNamePrefix: type: string formattedName: type: string fullName: type: string gender: type: string generation: type: string legalName: type: string location: type: string maritalStatus: type: string nationality: type: string placeOfBirth: type: string preferredGivenName: type: string title: type: string contactMedium: type: array items: title: ContactMedium type: object properties: mediumType: type: string preferred: type: boolean characteristic: title: Characteristic type: object properties: city: type: string contactType: type: string addressType: type: string placeName: type: string sectorName: type: string cellName: type: string districtName: type: string street1: type: string street2: type: string postCode: type: string stateOrProvince: type: string country: type: string emailAddress: type: string faxNumber: type: string phoneNumber: type: string alternateNumber: type: array items: type: object socialNetworkId: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string validFor: title: TimePeriod type: object properties: endDateTime: type: string startDateTime: type: string phoneNumber: type: string contactName: type: string role: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string creditRating: type: array items: title: CreditRating type: object properties: creditAgencyName: type: string creditAgencyType: type: string ratingReference: type: string ratingScore: type: integer format: int32 allottedCreditLimit: title: AllottedCreditLimit type: object properties: value: type: string unit: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string disability: type: array items: title: Disability type: object properties: disabilityCode: type: string disabilityName: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string externalReference: type: array items: title: ExternalReference type: object properties: externalReferenceType: type: string name: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string individualIdentification: type: array items: title: IndividualIdentification type: object properties: identificationId: type: string identificationType: type: string issuingAuthority: type: string issuingCountry: type: string issuingDate: type: string expiryDate: type: string attachment: title: Attachment type: object properties: id: type: string href: type: string attachmentType: type: string content: type: string description: type: string mimeType: type: string name: type: string url: type: string size: title: Size type: object properties: amount: type: integer format: int32 units: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string languageAbility: type: array items: title: LanguageAbility type: object properties: isFavouriteLanguage: type: boolean languageCode: type: string languageName: type: string listeningProficiency: type: string readingProficiency: type: string speakingProficiency: type: string writingProficiency: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string otherName: type: array items: title: OtherName type: object properties: aristocraticTitle: type: string familyName: type: string familyNamePrefix: type: string formattedName: type: string fullName: type: string generation: type: string givenName: type: string legalName: type: string middleName: type: string preferredGivenName: type: string title: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string partyCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_PartyCharacteristic' relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_RelatedParty' skill: type: array items: title: Skill type: object properties: comment: type: string evaluatedLevel: type: string skillCode: type: string skillName: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string status: type: string description: type: string recurring: type: boolean recurringCount: type: integer format: int32 reason: type: string '@referredType': type: string taxExemptionCertificate: type: array items: title: TaxExemptionCertificate type: object properties: id: type: string attachment: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_Attachment' taxDefinition: type: array items: title: TaxDefinition type: object properties: id: type: string name: type: string taxType: type: string referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string familyName: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false post: tags: - TMF632 Party Management summary: Register Individual Subscriber description: "This operation registers a new individual subscriber in the party\ \ management system. The endpoint supports multiple target systems including\ \ CSM, MORPH, and LCS, with comprehensive onboarding request types and partner\ \ management capabilities." operationId: PartyManagementService_post_registerSubscriber_individual parameters: - name: accountId in: query required: false schema: type: string - name: onboardingRequestType in: header required: false schema: type: string - name: requestType in: query required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: true schema: type: string - name: x-authorization in: header required: false schema: type: string - name: x-country-code in: header required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_holderInfo_GetHolderInfoResponseTmf' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /individual/{id}: get: tags: - TMF632 Party Management summary: Get Individual Entity by ID description: "This operation retrieves a specific Individual entity by ID with\ \ comprehensive attribute selection enabled for all first level attributes.\ \ The endpoint supports multiple filtering options including target system,\ \ country code, and various identity parameters." operationId: PartyManagementService_get_getIndividualById_individualid parameters: - name: attributeFlag in: query required: false schema: type: string - name: callBackUrl in: header required: false schema: type: string - name: countryCode in: header required: false schema: type: string - name: customerCode in: query required: false schema: type: string - name: dataValueSuffix in: query required: false schema: type: string - name: facilityId in: query required: false schema: type: string - name: facilityList in: query required: false schema: type: string - name: fields in: query required: false schema: type: string - name: id in: path required: true schema: type: string - name: idType in: query required: false schema: type: string - name: idValue in: query required: false schema: type: string - name: identityType in: query required: false schema: type: string - name: limit in: query required: false schema: type: string - name: lob in: query required: false schema: type: string - name: offset in: query required: false schema: type: string - name: operationName in: query required: false schema: type: string - name: referenceNumber in: query required: false schema: type: string - name: requestType in: query required: false schema: type: string - name: sort in: query required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-authorization in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: IndividualResponse type: object properties: result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string resultCode: type: string resultDescription: type: string transactionId: type: string data: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_IndividualResponseData' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false delete: tags: - TMF632 Party Management summary: Delete Individual Entry description: This operation deletes an individual entry from the party management system. The endpoint supports force removal options and backend system specification for proper cleanup of party-related data and associated resources. operationId: PartyManagementService_delete_deleteEntry_individualid parameters: - name: backendSystem in: query required: true schema: type: string - name: id in: path required: true schema: type: string - name: transactionId in: header required: true schema: type: string - name: usrForceRmv in: query required: false schema: type: integer format: int32 responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: GetHolderInfoResponseTmf type: object properties: id: type: string title: type: string middleName: type: string gender: type: string birthDate: type: string countryOfBirth: type: string placeOfBirth: type: string givenName: type: string familyName: type: string status: type: string languageAbility: type: array items: title: LanguageCode type: object properties: languageCode: type: string partyCharacteristic: type: array items: title: PartyCharacteristic type: object properties: name: type: string valueType: type: string value: type: string id: type: string recurring: type: boolean recurringCount: type: integer format: int32 relatedParty: type: array items: title: RelatedParty type: object properties: id: type: string href: type: string isRef: type: boolean name: type: string role: type: string referredType: type: string value: type: string description: type: string status: type: string isMinor: type: boolean validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string externalReference: type: array items: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string individualIdentification: type: array items: title: IndividualIdentificationItem type: object properties: identificationId: type: string identificationType: type: string issuingAuthority: type: string issuingDate: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string message: type: string code: type: string reason: type: string transactionId: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false patch: tags: - TMF632 Party Management summary: Update Individual Subscriber description: "This operation updates an existing individual subscriber in the\ \ party management system. The endpoint supports multiple update types including\ \ language changes, alternate number updates, customer information updates,\ \ and comprehensive plan management operations." operationId: PartyManagementService_patch_updateSubscriber_individualid parameters: - name: alternateNumber in: query required: false schema: type: string - name: id in: path required: true schema: type: string - name: requestType in: query required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: true schema: type: string - name: x-authorization in: header required: false schema: type: string - name: x-country-code in: header required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_IndividualResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /organization: post: tags: - TMF632 Party Management summary: Add Centrex IMS Group description: "This operation adds a new Centrex IMS group to the organization\ \ management system. The endpoint supports partner creation, tenant management,\ \ and various organization types with comprehensive system endpoint routing\ \ and validation." operationId: PartyManagementService_post_addCentrexImsGroup_organization parameters: - name: requestType in: query required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-country-code in: header required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: OrgResponse type: object properties: error: title: APIError type: object properties: error: type: string errorCode: type: string message: type: string status: type: string timestamp: type: string path: type: string transactionId: type: string reason: type: string referenceError: type: string sequenceNo: type: string code: type: string resultDescription: type: string data: title: ResponseData type: object properties: result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string sequenceNo: type: string data: title: DataDetails type: object properties: id: type: string name: type: string organizationParentRelationship: title: OrganizationRelationship type: object properties: organization: title: Organization type: object properties: id: type: string href: type: string name: type: string relatedParty: type: array items: title: RelatedPartyResponse type: object properties: id: type: string name: type: string status: type: string href: type: string reason: type: string status: type: string subStatus: type: string direction: type: string '@type': type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /organization/{id}: get: tags: - TMF632 Party Management summary: Get Partner Contracts description: This operation retrieves partner contracts and service status information from the organization management system. The endpoint supports multiple target systems including PPT and provides comprehensive contract management capabilities with detailed filtering options. operationId: PartyManagementService_get_getPartnerContracts_organizationid parameters: - name: countryCode in: query required: false schema: type: string - name: customerCode in: query required: false schema: type: string - name: description in: query required: false schema: type: string - name: id in: path required: true schema: type: string - name: idType in: query required: false schema: type: string - name: idValue in: query required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_party_response_OrgResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false patch: tags: - TMF632 Party Management summary: Delete Centrex IMS Group description: "This operation deletes or suspends a Centrex IMS group from the\ \ organization management system. The endpoint supports tenant suspension,\ \ revocation, and comprehensive cleanup of organization-related resources\ \ and dependencies." operationId: PartyManagementService_patch_deleteCentrexImsGroup_organizationid parameters: - name: id in: path required: true schema: type: string - name: requestType in: header required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: true schema: type: string - name: x-country-code in: header required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_party_response_OrgResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false components: schemas: com_mtn_aggregator_models_response_holderInfo_ValidFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string com_mtn_aggregator_models_request_GuarantorInfo: title: GuarantorInfo type: object properties: corporateName: type: string bizID: type: string lastName: type: string firstname: type: string middleName: type: string date: type: string gender: type: string nationalID: type: string passportNo: type: string driversLicence: type: string BVN: type: string otherID: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string phoneNumber: type: string emailAddress: type: string com_mtn_aggregator_models_partner_InteractionDate: title: InteractionDate type: object properties: startDateTime: type: string com_mtn_aggregator_models_response_individual_RelatedParty: title: RelatedParty type: object properties: id: type: string href: type: string isRef: type: boolean name: type: string role: type: string referredType: type: string value: type: string description: type: string status: type: string isMinor: type: boolean validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string com_mtn_aggregator_models_response_individual_ExternalReference: title: ExternalReference type: object properties: externalReferenceType: type: string name: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_response_individual_IndividualResponseData: title: IndividualResponseData type: object properties: id: type: string href: type: string aristocraticTitle: type: string birthDate: type: string countryOfBirth: type: string deathDate: type: string firstName: type: string middleName: type: string lastName: type: string familyNamePrefix: type: string formattedName: type: string fullName: type: string gender: type: string generation: type: string legalName: type: string location: type: string maritalStatus: type: string nationality: type: string placeOfBirth: type: string preferredGivenName: type: string title: type: string contactMedium: type: array items: title: ContactMedium type: object properties: mediumType: type: string preferred: type: boolean characteristic: title: Characteristic type: object properties: city: type: string contactType: type: string addressType: type: string placeName: type: string sectorName: type: string cellName: type: string districtName: type: string street1: type: string street2: type: string postCode: type: string stateOrProvince: type: string country: type: string emailAddress: type: string faxNumber: type: string phoneNumber: type: string alternateNumber: type: array items: type: object socialNetworkId: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string validFor: title: TimePeriod type: object properties: endDateTime: type: string startDateTime: type: string phoneNumber: type: string contactName: type: string role: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string creditRating: type: array items: title: CreditRating type: object properties: creditAgencyName: type: string creditAgencyType: type: string ratingReference: type: string ratingScore: type: integer format: int32 allottedCreditLimit: title: AllottedCreditLimit type: object properties: value: type: string unit: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string disability: type: array items: title: Disability type: object properties: disabilityCode: type: string disabilityName: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string externalReference: type: array items: title: ExternalReference type: object properties: externalReferenceType: type: string name: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string individualIdentification: type: array items: title: IndividualIdentification type: object properties: identificationId: type: string identificationType: type: string issuingAuthority: type: string issuingCountry: type: string issuingDate: type: string expiryDate: type: string attachment: title: Attachment type: object properties: id: type: string href: type: string attachmentType: type: string content: type: string description: type: string mimeType: type: string name: type: string url: type: string size: title: Size type: object properties: amount: type: integer format: int32 units: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string languageAbility: type: array items: title: LanguageAbility type: object properties: isFavouriteLanguage: type: boolean languageCode: type: string languageName: type: string listeningProficiency: type: string readingProficiency: type: string speakingProficiency: type: string writingProficiency: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string otherName: type: array items: title: OtherName type: object properties: aristocraticTitle: type: string familyName: type: string familyNamePrefix: type: string formattedName: type: string fullName: type: string generation: type: string givenName: type: string legalName: type: string middleName: type: string preferredGivenName: type: string title: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string partyCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_PartyCharacteristic' relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_RelatedParty' skill: type: array items: title: Skill type: object properties: comment: type: string evaluatedLevel: type: string skillCode: type: string skillName: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string status: type: string description: type: string recurring: type: boolean recurringCount: type: integer format: int32 reason: type: string '@referredType': type: string taxExemptionCertificate: type: array items: title: TaxExemptionCertificate type: object properties: id: type: string attachment: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_Attachment' taxDefinition: type: array items: title: TaxDefinition type: object properties: id: type: string name: type: string taxType: type: string referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string familyName: type: string com_mtn_aggregator_models_response_individual_TaxExemptionCertificate: title: TaxExemptionCertificate type: object properties: id: type: string attachment: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_Attachment' taxDefinition: type: array items: title: TaxDefinition type: object properties: id: type: string name: type: string taxType: type: string referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_partner_Result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string sequenceNo: type: string com_mtn_aggregator_models_request_ContactMediumOne: title: ContactMediumOne type: object properties: addressOne: type: string addressTwo: type: string lga: type: string state: type: string preferred: type: boolean com_mtn_aggregator_models_response_individual_TimePeriod: title: TimePeriod type: object properties: endDateTime: type: string startDateTime: type: string com_mtn_aggregator_models_response_holderInfo_LanguageCode: title: LanguageCode type: object properties: languageCode: type: string com_mtn_aggregator_models_response_individual_LanguageAbility: title: LanguageAbility type: object properties: isFavouriteLanguage: type: boolean languageCode: type: string languageName: type: string listeningProficiency: type: string readingProficiency: type: string speakingProficiency: type: string writingProficiency: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_response_individual_Skill: title: Skill type: object properties: comment: type: string evaluatedLevel: type: string skillCode: type: string skillName: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_request_PrincipalInfo: title: PrincipalInfo type: object properties: lastName: type: string firstName: type: string middleName: type: string dateOfBirth: type: string gender: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string nationalId: type: string driversLicence: type: string BVN: type: string passportNo: type: string phoneNumber: type: string email: type: string designation: type: string com_mtn_aggregator_models_request_BusinessInfo: title: BusinessInfo type: object properties: Id: type: string name: type: string type: type: string category: type: string dateOfIncorporation: type: string customerId: type: string branchCode: type: string contactMedium: type: array items: title: ContactMediumOne type: object properties: addressOne: type: string addressTwo: type: string lga: type: string state: type: string preferred: type: boolean country: type: string com_mtn_aggregator_models_response_individual_Characteristic: title: Characteristic type: object properties: city: type: string contactType: type: string addressType: type: string placeName: type: string sectorName: type: string cellName: type: string districtName: type: string street1: type: string street2: type: string postCode: type: string stateOrProvince: type: string country: type: string emailAddress: type: string faxNumber: type: string phoneNumber: type: string alternateNumber: type: array items: type: object socialNetworkId: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_response_crc_CRCResponse: title: CRCResponse type: object properties: transactionId: type: string timestamp: type: string status: type: string error: type: string message: type: string result: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_Result' com_mtn_aggregator_models_response_individual_IndividualResponse: title: IndividualResponse type: object properties: result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string resultCode: type: string resultDescription: type: string transactionId: type: string data: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_IndividualResponseData' com_mtn_aggregator_models_request_CreditRecord: title: CreditRecord type: object properties: dateOfLoan: type: string creditLimit: type: string availedLimit: type: string outstandingBalance: type: string installmentAmount: type: string currency: type: string daysInArrears: type: string overDueAmount: type: string loanType: type: string loanTenor: type: string repaymentFrequency: type: string lastPaymentDate: type: string lastPaymentAmount: type: string maturityDate: type: string loanClassification: type: string legalChallengeStatus: type: string litigationDate: type: string consentStatus: type: string loanSecurityStatus: type: string collateralType: type: string collateralDetails: type: string previousAccountNumber: type: string previousName: type: string previousCustomerId: type: string previousBranchCode: type: string com_mtn_aggregator_models_response_individual_PartyCharacteristic: title: PartyCharacteristic type: object properties: name: type: string valueType: type: string value: type: string id: type: string recurring: type: boolean recurringCount: type: integer format: int32 relatedParty: type: array items: title: RelatedParty type: object properties: id: type: string href: type: string isRef: type: boolean name: type: string role: type: string referredType: type: string value: type: string description: type: string status: type: string isMinor: type: boolean validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string externalReference: type: array items: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_partner_Organization: title: Organization type: object properties: id: type: string href: type: string name: type: string com_mtn_aggregator_models_partner_OrganizationRelationship: title: OrganizationRelationship type: object properties: organization: title: Organization type: object properties: id: type: string href: type: string name: type: string APIError: title: APIError required: - statusCode - statusMessage type: object properties: statusCode: type: string description: Error status code statusMessage: type: string description: Human-readable error message supportMessage: type: string description: Technical support message or error code for troubleshooting transactionId: type: string description: Transaction identifier for tracking and correlation sequenceNo: type: string description: Sequence number for request tracking timestamp: type: string description: Error timestamp in ISO 8601 format format: date-time path: type: string description: API endpoint path where the error occurred method: type: string description: HTTP method of the request that caused the error downstreamStatusCode: type: string description: Downstream service error code if applicable description: Generic MADAPI error response structure com_mtn_aggregator_models_party_response_OrgResponse: title: OrgResponse type: object properties: error: title: APIError type: object properties: error: type: string errorCode: type: string message: type: string status: type: string timestamp: type: string path: type: string transactionId: type: string reason: type: string referenceError: type: string sequenceNo: type: string code: type: string resultDescription: type: string data: title: ResponseData type: object properties: result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string sequenceNo: type: string data: title: DataDetails type: object properties: id: type: string name: type: string organizationParentRelationship: title: OrganizationRelationship type: object properties: organization: title: Organization type: object properties: id: type: string href: type: string name: type: string relatedParty: type: array items: title: RelatedPartyResponse type: object properties: id: type: string name: type: string status: type: string href: type: string reason: type: string status: type: string subStatus: type: string direction: type: string '@type': type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string com_mtn_aggregator_models_partner_RelatedPartyResponse: title: RelatedPartyResponse type: object properties: id: type: string name: type: string status: type: string com_mtn_aggregator_models_response_individual_Attachment: title: Attachment type: object properties: id: type: string href: type: string attachmentType: type: string content: type: string description: type: string mimeType: type: string name: type: string url: type: string size: title: Size type: object properties: amount: type: integer format: int32 units: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string com_mtn_aggregator_models_party_response_ValidFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string com_mtn_aggregator_models_response_holderInfo_GetHolderInfoResponseTmf: title: GetHolderInfoResponseTmf type: object properties: id: type: string title: type: string middleName: type: string gender: type: string birthDate: type: string countryOfBirth: type: string placeOfBirth: type: string givenName: type: string familyName: type: string status: type: string languageAbility: type: array items: title: LanguageCode type: object properties: languageCode: type: string partyCharacteristic: type: array items: title: PartyCharacteristic type: object properties: name: type: string valueType: type: string value: type: string id: type: string recurring: type: boolean recurringCount: type: integer format: int32 relatedParty: type: array items: title: RelatedParty type: object properties: id: type: string href: type: string isRef: type: boolean name: type: string role: type: string referredType: type: string value: type: string description: type: string status: type: string isMinor: type: boolean validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string externalReference: type: array items: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string individualIdentification: type: array items: title: IndividualIdentificationItem type: object properties: identificationId: type: string identificationType: type: string issuingAuthority: type: string issuingDate: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string message: type: string code: type: string reason: type: string transactionId: type: string com_mtn_aggregator_models_response_individual_IndividualIdentification: title: IndividualIdentification type: object properties: identificationId: type: string identificationType: type: string issuingAuthority: type: string issuingCountry: type: string issuingDate: type: string expiryDate: type: string attachment: title: Attachment type: object properties: id: type: string href: type: string attachmentType: type: string content: type: string description: type: string mimeType: type: string name: type: string url: type: string size: title: Size type: object properties: amount: type: integer format: int32 units: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_response_individual_Size: title: Size type: object properties: amount: type: integer format: int32 units: type: string com_mtn_aggregator_models_response_individual_OtherName: title: OtherName type: object properties: aristocraticTitle: type: string familyName: type: string familyNamePrefix: type: string formattedName: type: string fullName: type: string generation: type: string givenName: type: string legalName: type: string middleName: type: string preferredGivenName: type: string title: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_response_individual_TaxDefinition: title: TaxDefinition type: object properties: id: type: string name: type: string taxType: type: string referredType: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_partner_DataDetails: title: DataDetails type: object properties: id: type: string name: type: string organizationParentRelationship: title: OrganizationRelationship type: object properties: organization: title: Organization type: object properties: id: type: string href: type: string name: type: string relatedParty: type: array items: title: RelatedPartyResponse type: object properties: id: type: string name: type: string status: type: string href: type: string reason: type: string status: type: string subStatus: type: string direction: type: string '@type': type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string com_mtn_aggregator_models_response_individual_Disability: title: Disability type: object properties: disabilityCode: type: string disabilityName: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_request_CreditInfo: title: CreditInfo type: object properties: customerId: type: string branchCode: type: string lastName: type: string firstName: type: string middleName: type: string dateOfBirth: type: string nationalIdentityNumber: type: string driversLicense: type: string BVN: type: string passportNo: type: string gender: type: string nationality: type: string maritalStatus: type: string phoneNumberOne: type: string primaryAddressOne: type: string primaryAddressTwo: type: string countryLgaOne: type: string countryStateOne: type: string countryOne: type: string employmentStatus: type: string occupation: type: string businessCategory: type: string businessSector: type: string BorrowerType: type: string otherID: type: string taxID: type: string pictureFilePath: type: string emailAddress: type: string employerName: type: string employerAddressOne: type: string employerAddressTwo: type: string employerLga: type: string employerState: type: string employerCountry: type: string title: type: string placeOfBirth: type: string phoneNumberTwo: type: string phoneNumberThree: type: string secondaryAddressOne: type: string secondaryAddressTwo: type: string secondaryAddressLga: type: string secondaryAddressState: type: string secondaryAddressCountry: type: string spousesLastName: type: string spousesFirstName: type: string spousesMiddleName: type: string businessInfo: title: BusinessInfo type: object properties: Id: type: string name: type: string type: type: string category: type: string dateOfIncorporation: type: string customerId: type: string branchCode: type: string contactMedium: type: array items: title: ContactMediumOne type: object properties: addressOne: type: string addressTwo: type: string lga: type: string state: type: string preferred: type: boolean country: type: string guarantorInfo: type: array items: title: GuarantorInfo type: object properties: corporateName: type: string bizID: type: string lastName: type: string firstname: type: string middleName: type: string date: type: string gender: type: string nationalID: type: string passportNo: type: string driversLicence: type: string BVN: type: string otherID: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string phoneNumber: type: string emailAddress: type: string creditInfo: title: CreditRecord type: object properties: dateOfLoan: type: string creditLimit: type: string availedLimit: type: string outstandingBalance: type: string installmentAmount: type: string currency: type: string daysInArrears: type: string overDueAmount: type: string loanType: type: string loanTenor: type: string repaymentFrequency: type: string lastPaymentDate: type: string lastPaymentAmount: type: string maturityDate: type: string loanClassification: type: string legalChallengeStatus: type: string litigationDate: type: string consentStatus: type: string loanSecurityStatus: type: string collateralType: type: string collateralDetails: type: string previousAccountNumber: type: string previousName: type: string previousCustomerId: type: string previousBranchCode: type: string principalInfo: type: array items: title: PrincipalInfo type: object properties: lastName: type: string firstName: type: string middleName: type: string dateOfBirth: type: string gender: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string nationalId: type: string driversLicence: type: string BVN: type: string passportNo: type: string phoneNumber: type: string email: type: string designation: type: string loanStatus: type: string guaranteeType: type: string accountNumber: type: string accountStatus: type: string accountStatusDate: type: string taxId: type: string dateOfLoan: type: string creditLimit: type: string availedLimit: type: string outstandingBalance: type: string installmentAmount: type: string currency: type: string daysInArrears: type: string overDueAmount: type: string loanType: type: string loanTenor: type: string repaymentFrequency: type: string lastPaymentDate: type: string lastPaymentAmount: type: string maturityDate: type: string loanClassification: type: string legalChallengeStatus: type: string litigationDate: type: string consentStatus: type: string loanSecurityStatus: type: string collateralType: type: string collateralDetails: type: string previousAccountNumber: type: string previousName: type: string previousCustomerId: type: string previousBranchCode: type: string com_mtn_aggregator_models_party_response_AllottedCreditLimit: title: AllottedCreditLimit type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_error_APIError: title: APIError type: object properties: error: type: string errorCode: type: string message: type: string status: type: string timestamp: type: string path: type: string transactionId: type: string reason: type: string referenceError: type: string sequenceNo: type: string code: type: string resultDescription: type: string com_mtn_aggregator_models_partner_ResponseData: title: ResponseData type: object properties: result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string sequenceNo: type: string data: title: DataDetails type: object properties: id: type: string name: type: string organizationParentRelationship: title: OrganizationRelationship type: object properties: organization: title: Organization type: object properties: id: type: string href: type: string name: type: string relatedParty: type: array items: title: RelatedPartyResponse type: object properties: id: type: string name: type: string status: type: string href: type: string reason: type: string status: type: string subStatus: type: string direction: type: string '@type': type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string com_mtn_aggregator_models_request_CreditInfoRequest: title: CreditInfoRequest type: object properties: creditInfo: type: array items: title: CreditInfo type: object properties: customerId: type: string branchCode: type: string lastName: type: string firstName: type: string middleName: type: string dateOfBirth: type: string nationalIdentityNumber: type: string driversLicense: type: string BVN: type: string passportNo: type: string gender: type: string nationality: type: string maritalStatus: type: string phoneNumberOne: type: string primaryAddressOne: type: string primaryAddressTwo: type: string countryLgaOne: type: string countryStateOne: type: string countryOne: type: string employmentStatus: type: string occupation: type: string businessCategory: type: string businessSector: type: string BorrowerType: type: string otherID: type: string taxID: type: string pictureFilePath: type: string emailAddress: type: string employerName: type: string employerAddressOne: type: string employerAddressTwo: type: string employerLga: type: string employerState: type: string employerCountry: type: string title: type: string placeOfBirth: type: string phoneNumberTwo: type: string phoneNumberThree: type: string secondaryAddressOne: type: string secondaryAddressTwo: type: string secondaryAddressLga: type: string secondaryAddressState: type: string secondaryAddressCountry: type: string spousesLastName: type: string spousesFirstName: type: string spousesMiddleName: type: string businessInfo: title: BusinessInfo type: object properties: Id: type: string name: type: string type: type: string category: type: string dateOfIncorporation: type: string customerId: type: string branchCode: type: string contactMedium: type: array items: title: ContactMediumOne type: object properties: addressOne: type: string addressTwo: type: string lga: type: string state: type: string preferred: type: boolean country: type: string guarantorInfo: type: array items: title: GuarantorInfo type: object properties: corporateName: type: string bizID: type: string lastName: type: string firstname: type: string middleName: type: string date: type: string gender: type: string nationalID: type: string passportNo: type: string driversLicence: type: string BVN: type: string otherID: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string phoneNumber: type: string emailAddress: type: string creditInfo: title: CreditRecord type: object properties: dateOfLoan: type: string creditLimit: type: string availedLimit: type: string outstandingBalance: type: string installmentAmount: type: string currency: type: string daysInArrears: type: string overDueAmount: type: string loanType: type: string loanTenor: type: string repaymentFrequency: type: string lastPaymentDate: type: string lastPaymentAmount: type: string maturityDate: type: string loanClassification: type: string legalChallengeStatus: type: string litigationDate: type: string consentStatus: type: string loanSecurityStatus: type: string collateralType: type: string collateralDetails: type: string previousAccountNumber: type: string previousName: type: string previousCustomerId: type: string previousBranchCode: type: string principalInfo: type: array items: title: PrincipalInfo type: object properties: lastName: type: string firstName: type: string middleName: type: string dateOfBirth: type: string gender: type: string addressOne: type: string addressTwo: type: string lga: type: string state: type: string country: type: string nationalId: type: string driversLicence: type: string BVN: type: string passportNo: type: string phoneNumber: type: string email: type: string designation: type: string loanStatus: type: string guaranteeType: type: string accountNumber: type: string accountStatus: type: string accountStatusDate: type: string taxId: type: string dateOfLoan: type: string creditLimit: type: string availedLimit: type: string outstandingBalance: type: string installmentAmount: type: string currency: type: string daysInArrears: type: string overDueAmount: type: string loanType: type: string loanTenor: type: string repaymentFrequency: type: string lastPaymentDate: type: string lastPaymentAmount: type: string maturityDate: type: string loanClassification: type: string legalChallengeStatus: type: string litigationDate: type: string consentStatus: type: string loanSecurityStatus: type: string collateralType: type: string collateralDetails: type: string previousAccountNumber: type: string previousName: type: string previousCustomerId: type: string previousBranchCode: type: string userId: type: string com_mtn_aggregator_models_response_holderInfo_IndividualIdentificationItem: title: IndividualIdentificationItem type: object properties: identificationId: type: string identificationType: type: string issuingAuthority: type: string issuingDate: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string com_mtn_aggregator_models_response_individual_CreditRating: title: CreditRating type: object properties: creditAgencyName: type: string creditAgencyType: type: string ratingReference: type: string ratingScore: type: integer format: int32 allottedCreditLimit: title: AllottedCreditLimit type: object properties: value: type: string unit: type: string validFor: $ref: '#/components/schemas/com_mtn_aggregator_models_response_individual_TimePeriod' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_response_individual_ContactMedium: title: ContactMedium type: object properties: mediumType: type: string preferred: type: boolean characteristic: title: Characteristic type: object properties: city: type: string contactType: type: string addressType: type: string placeName: type: string sectorName: type: string cellName: type: string districtName: type: string street1: type: string street2: type: string postCode: type: string stateOrProvince: type: string country: type: string emailAddress: type: string faxNumber: type: string phoneNumber: type: string alternateNumber: type: array items: type: object socialNetworkId: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string validFor: title: TimePeriod type: object properties: endDateTime: type: string startDateTime: type: string phoneNumber: type: string contactName: type: string role: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string href: type: string com_mtn_aggregator_models_response_individual_Result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: https://api.mtn.com/v1/oauth/access_token scopes: {} Bearer: type: http description: Bearer token received from OAuth2.0 authentication with the MADAPI scheme: bearer bearerFormat: JWT