{ "openapi": "3.0.1", "info": { "title": "Credit Application Management", "description": "This is Swagger UI environment generated for the TMF FederatedID specification", "version": "4.0" }, "servers": [ { "url": "http://serverRoot/tmf-api/openid/v4" } ], "tags": [], "paths": { "/credit-application-api/v1/submit": { "post": { "tags": [], "summary": "Submit Credit Application", "description": "This operation submits credit application for an Individual", "operationId": "CreditApplication", "requestBody": { "description": "Data containing the User Identity information", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreditApplicationRequest" }, "examples": { "CreditApplicationRequestWith-SSN": { "value": { "userInfo": { "birthdate": "1970-11-02", "family_name": "Doe", "given_name": "Steven", "address": { "id": "ADDRESS-ID-100001", "postcode": "98021", "stateOrProvince": "WA", "addressCharacteristic": [ { "name": "addressLine1", "value": "9927 BRENTLINGER LANE" } ] }, "legalId": [ { "identificationId": "666602764", "identificationType": "SocialSecurityNumber" } ] }, "channel": { "id": "SelfService", "name": "SelfService", "role": "Customer" }, "relatedParty": { "id": "INDIVIDUAL-ID-00001", "@referredType": "Individual" } } }, "CreditApplicationRequest-DL": { "value": { "userInfo": { "birthdate": "1970-11-02", "family_name": "Doe", "given_name": "Steven", "address": { "id": "ADDRESS-ID-100001", "postcode": "98021", "stateOrProvince": "WA", "addressCharacteristic": [ { "name": "addressLine1", "value": "9927 BRENTLINGER LANE" } ] }, "legalId": [ { "identificationId": "DL-1345*NRT", "identificationType": "DL", "issuingAuthority": "UT", "expirationDate": "2024-07-14" } ] }, "channel": { "id": "SelfService", "name": "SelfService", "role": "Customer" }, "relatedParty": { "id": "INDIVIDUAL-ID-00001", "@referredType": "Individual" } } }, "ExistingCustomer-CreditCheck": { "value": { "accountDetails": { "id": "12312345", "accountType": "wireless" }, "channel": { "id": "SelfService", "name": "SelfService", "role": "Customer" }, "relatedParty": { "id": "INDIVIDUAL-ID-00001", "@referredType": "Individual" } } }, "ExistingCustomer-WithSSN-Input": { "value": { "accountDetails": { "id": "12312345", "accountType": "wireless" }, "userInfo": { "birthdate": "1970-11-02", "family_name": "Doe", "given_name": "Steven", "address": { "id": "ADDRESS-ID-100001", "postcode": "98021", "stateOrProvince": "WA", "addressCharacteristic": [ { "name": "addressLine1", "value": "9927 BRENTLINGER LANE" } ] }, "legalId": [ { "identificationId": "666602764", "identificationType": "SocialSecurityNumber" } ] }, "channel": { "id": "SelfService", "name": "SelfService", "role": "Customer" }, "relatedParty": { "id": "INDIVIDUAL-ID-00001", "@referredType": "Individual" } } }, "CreditApplicationWithNameAndAddressOnly": { "value": { "accountDetails": { "accountType": "string", "id": "string", "@type": "string", "@referredType": "string" }, "applicationDetails": { "id": "string", "unifiedCreditTransactionId": "string", "unifiedPolicyTransactionId": "string", "refusedIndicator": true, "debtPaymentComplete": true }, "userInfo": { "birthdate": "1970-11-02", "email": "jane.doe@email.com", "email_verified": false, "family_name": "Doe", "gender": "female", "given_name": "Jane", "locale": "en", "middle_name": "Mary", "name": "Jane Mary Doe", "nickname": "JaneDoe", "phone_number": "+1 (425) 555-1212", "phone_number_verified": false, "picture": "https://some.url.com/janeDoe.jpg", "preferred_username": "janeDoe", "profile": "https://my.blog.com/janeDoe", "sub": "a066ffd5-f685-43bc-ad57-bfb7639decb0", "website": "https://janedoe.com", "zoneinfo": "America/Los_Angeles", "address": { "id": "string", "href": "string", "city": "string", "country": "string", "locality": "string", "name": "string", "postcode": "string", "stateOrProvince": "string", "streetName": "string", "streetNr": "string", "streetNrLast": "string", "streetNrLastSuffix": "string", "streetNrSuffix": "string", "streetSuffix": "string", "streetType": "string", "geographicLocation": { "id": "string", "href": "string", "name": "string", "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string", "@referredType": "string" }, "geographicSubAddress": [ { "id": "string", "href": "string", "buildingName": "string", "levelNumber": "string", "levelType": "string", "name": "string", "privateStreetName": "string", "privateStreetNumber": "string", "subAddressType": "string", "subUnitNumber": "string", "subUnitType": "string" } ], "addressCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string" } ], "value": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ] }, "previousAddress": { "id": "string", "href": "string", "city": "string", "country": "string", "locality": "string", "name": "string", "postcode": "string", "stateOrProvince": "string", "streetName": "string", "streetNr": "string", "streetNrLast": "string", "streetNrLastSuffix": "string", "streetNrSuffix": "string", "streetSuffix": "string", "streetType": "string", "geographicLocation": { "id": "string", "href": "string", "name": "string", "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string", "@referredType": "string" }, "geographicSubAddress": [ { "id": "string", "href": "string", "buildingName": "string", "levelNumber": "string", "levelType": "string", "name": "string", "privateStreetName": "string", "privateStreetNumber": "string", "subAddressType": "string", "subUnitNumber": "string", "subUnitType": "string" } ], "addressCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string" } ], "value": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ] }, "legalId": [ { "identificationId": "string", "identificationType": "string", "issuingAuthority": "string", "issuingDate": "string", "expirationDate": "string", "attachment": { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "string", "description": "Photograph of the Product", "mimeType": "string", "name": "string", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "string" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.520Z", "startDateTime": "1985-04-12T23:20:50.520Z" }, "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string", "@referredType": "string" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.520Z", "startDateTime": "1985-04-12T23:20:50.520Z" } } ], "userAssets": [ { "id": "f066ffd5-e685-43bc-ad57-bfb7639decb1", "assetType": "string", "entityType": "string", "role": "owner", "entitlement": [ { "id": "string", "action": "string", "function": "string" } ] } ] }, "channel": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string", "@referredType": "string" }, "relatedParty": { "id": "string", "href": "string", "name": "string", "role": "string", "extensions": { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string" } ], "value": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" }, "@baseType": "string", "@schemaLocation": "http://example.com", "@type": "string", "@referredType": "string" } } } } } }, "required": true }, "parameters": [ { "name": "Authorization", "in": "header", "description": "token to be passed as a header linked to the user whose identity is requested", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Total-Count": { "description": "Total number of items matching criteria", "schema": { "type": "integer" } }, "X-Result-Count": { "description": "Actual number of items returned in the response body", "schema": { "type": "integer" } } }, "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreditApplicationResult" }, "examples": { "CreditApplication-Success": { "value": { "id": "110137566582", "href": "string", "status": "success", "characteristic": [ { "name": "UnifiedCreditTransactionId", "value": "U20211013304398588" } ] } }, "CreditApplication-IDConfidenceRisk": { "value": { "id": "110137566582", "href": "string", "status": "failed", "characteristic": [ { "name": "UnifiedCreditTransactionId", "value": "U20211013304398588" } ], "riskAssessmentResult": { "validFor": { "startDateTime": "2017-08-23T00:00:22.920Z", "endDateTime": "2018-03-25T00:00:22.920Z" }, "score": [ { "riskName": "IDConfidenceRisk" } ] } } }, "CreditApplication-FraudRisk": { "value": { "id": "110137566582", "href": "string", "status": "failed", "characteristic": [ { "name": "UnifiedCreditTransactionId", "value": "U20211013304398588" } ], "riskAssessmentResult": { "validFor": { "startDateTime": "2017-08-23T00:00:22.920Z", "endDateTime": "2018-03-25T00:00:22.920Z" }, "score": [ { "riskName": "FraudRisk" } ] } } }, "CreditApplication-BadPaymentRisk": { "value": { "id": "110137566582", "status": "failed", "characteristic": [ { "name": "UnifiedCreditTransactionId", "value": "U20211013304398588" } ], "riskAssessmentResult": { "validFor": { "startDateTime": "2017-08-23T00:00:22.920Z", "endDateTime": "2018-03-25T00:00:22.920Z" }, "score": [ { "riskName": "BadPaymentRisk" } ] }, "accountDebtDetails": [ { "billingFullName": "Joe Daniel", "affiliateAccountNumber": "110057742836", "affiliateId": "MT", "accountCategory": "MOBILITY", "debtDetails": { "accountClass": "C", "accountBalance": 242.88, "pastDueAmount": 242.88, "minimumAmountDue": 100 }, "serviceAddress": { "city": "MC FARLAND", "postcode": "98021", "stateOrProvince": "CA", "addressCharacteristic": [ { "name": "addressLine1", "value": "143 MARSHALL ST" } ] }, "billingAddress": { "city": "MC FARLAND", "postcode": "98021", "stateOrProvince": "CA", "addressCharacteristic": [ { "name": "addressLine1", "value": "143 MARSHALL ST" } ] } } ] } }, "CreditApplication-IDConfidenceRisk-VerificationRequired": { "value": { "id": "110137566582", "status": "failed", "characteristic": [ { "name": "UnifiedCreditTransactionId", "value": "U20211013304398588" }, { "name": "IdentityVerificationRequired", "value": "true" } ], "riskAssessmentResult": { "validFor": { "startDateTime": "2017-08-23T00:00:22.920Z", "endDateTime": "2018-03-25T00:00:22.920Z" }, "score": [ { "riskName": "IDConfidenceRisk" } ] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "parameters": [] } }, "components": { "schemas": { "Addressable": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" } }, "description": "Base schema for adressable entities" }, "Attachment": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this particular attachment", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f" }, "href": { "type": "string", "description": "URI for this Attachment", "format": "uri", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "attachmentType": { "type": "string", "description": "Attachment type such as video, picture", "example": "video" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64", "format": "base64" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment", "example": "Photograph of the Product" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "name": { "type": "string", "description": "The name of the attachment" }, "url": { "type": "string", "description": "Uniform Resource Locator, is a web page address (a subset of URI)", "format": "uri", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "size": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Complements the description of an element (for instance a product) through video, pictures..." }, "AttachmentRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique-Identifier for this attachment" }, "href": { "type": "string", "description": "URL serving as reference for the attachment resource", "format": "uri" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "name": { "type": "string", "description": "Name of the related entity." }, "url": { "type": "string", "description": "Link to the attachment media/content", "format": "uri" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures" }, "AttachmentRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this particular attachment", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f" }, "href": { "type": "string", "description": "URI for this Attachment", "format": "uri", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "attachmentType": { "type": "string", "description": "Attachment type such as video, picture", "example": "video" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64", "format": "base64" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment", "example": "Photograph of the Product" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "name": { "type": "string", "description": "The name of the attachment" }, "url": { "type": "string", "description": "Uniform Resource Locator, is a web page address (a subset of URI)", "format": "uri", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "size": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture." }, "Entitlement": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the entitlement." }, "action": { "type": "string", "description": "Level of access granted as part of the permission." }, "function": { "type": "string", "description": "Specific function that can be managed over a given asset." } }, "description": "An Entitlement defines access levels to operate over a given function that can be included in an asset." }, "EntityRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Entity reference schema to be use for all entityRef class." }, "Extensible": { "type": "object", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } }, "description": "Base Extensible schema for use in TMForum Open-APIs" }, "GeographicAddress": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "city": { "type": "string", "description": "City that the address is in" }, "country": { "type": "string", "description": "Country that the address is in" }, "locality": { "type": "string", "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "postcode": { "type": "string", "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" }, "stateOrProvince": { "type": "string", "description": "the State or Province that the address is in" }, "streetName": { "type": "string", "description": "Name of the street or other street type" }, "streetNr": { "type": "string", "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" }, "streetNrLast": { "type": "string", "description": "Last number in a range of street numbers allocated to a property" }, "streetNrLastSuffix": { "type": "string", "description": "Last street number suffix for a ranged address" }, "streetNrSuffix": { "type": "string", "description": "the first street number suffix" }, "streetSuffix": { "type": "string", "description": "A modifier denoting a relative direction" }, "streetType": { "type": "string", "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " }, "geographicLocation": { "$ref": "#/components/schemas/GeographicLocationRefOrValue" }, "geographicSubAddress": { "type": "array", "items": { "$ref": "#/components/schemas/GeographicSubAddress" } }, "addressCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } } }, "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress" }, "GeographicLocation": { "required": [ "@type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the geographic location" }, "href": { "type": "string", "description": "An URI used to access to the geographic location resource" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@type": { "type": "string", "description": "The name of the GeoJSON structure used in the geometry attribute" } }, "description": "A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highways and boundaries), MultiLineString and Polygon (countries, provinces, tracts of land). Use the @type attribute to specify which of these is being specified by the geometry attribute." }, "GeographicLocationRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference", "format": "uri" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "GeographicLocationRefOrValue": { "required": [ "@type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "The name of the GeoJSON structure used in the geometry attribute" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highways and boundaries), MultiLineString and Polygon (countries, provinces, tracts of land). Use the @type attribute to specify which of these is being specified by the geometry attribute." }, "GeographicSubAddress": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Identifier of the subAddress" }, "href": { "type": "string", "description": "Link to the subAddress" }, "buildingName": { "type": "string", "description": "allows for buildings that have well-known names" }, "levelNumber": { "type": "string", "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" }, "levelType": { "type": "string", "description": "describes level types within a building" }, "name": { "type": "string", "description": "Name of the subAddress to identify it with a meaningful identification" }, "privateStreetName": { "type": "string", "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." }, "privateStreetNumber": { "type": "string", "description": "private streets numbers internal to a private street" }, "subAddressType": { "type": "string", "description": "Type of subAddress : it can be a subunit or a private street" }, "subUnitNumber": { "type": "string", "description": "the discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" }, "subUnitType": { "type": "string", "description": "the type of subunit\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" } }, "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building." }, "IndividualIdentification": { "type": "object", "properties": { "identificationId": { "type": "string", "description": "Identifier" }, "identificationType": { "type": "string", "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" }, "issuingAuthority": { "type": "string", "description": "Authority which has issued the identifier, such as: social security, town hall" }, "issuingDate": { "type": "string", "description": "Date at which the identifier was issued" }, "expirationDate": { "type": "string", "description": "ATT++::Date at which the identifier will be expired" }, "attachment": { "$ref": "#/components/schemas/AttachmentRefOrValue" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)" }, "Place": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" } }, "description": "Place reference. Place defines the places where the products are sold or delivered." }, "Quantity": { "type": "object", "properties": { "amount": { "type": "number", "description": "Numeric value in a given unit", "format": "float", "default": 1 }, "units": { "type": "string", "description": "Unit" } }, "description": "An amount in a given unit" }, "TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "End of the time period, using IETC-RFC-3339 format", "format": "date-time", "example": "1985-04-12T23:20:50.520Z" }, "startDateTime": { "type": "string", "description": "Start of the time period, using IETC-RFC-3339 format", "format": "date-time", "example": "1985-04-12T23:20:50.520Z" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "UserAsset": { "required": [ "entityType", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of referenced entity within the entity/asset pair (customerId, accountId, mobile line number, ...)", "example": "f066ffd5-e685-43bc-ad57-bfb7639decb1" }, "assetType": { "type": "string", "description": "Second level to define the type of managed element for product/service/resource managed entities (e.g.: mobile line subscription, video platform license, mobile equipment, etc). Allows identifying the specific asset within the server referenced. Supported values are implementation and application specific. Other values can be added if those listed are not enough" }, "entityType": { "type": "string", "description": "Type of managed entity (e.g.: product, resource, service, customer, account)" }, "role": { "type": "string", "description": "Represents the part played by an individual in relation to being granted a set of entitlements for manageable assets (e.g.: owner, user, viewer, ...)", "example": "owner" }, "entitlement": { "type": "array", "description": "information about individual entitlements to define access levels to operate over different functions that can be defined in an asset", "items": { "$ref": "#/components/schemas/Entitlement" } } } }, "Userinfo": { "required": [ "given_name", "family_name" ], "type": "object", "properties": { "birthdate": { "type": "string", "description": "End-User's birthday, represented as an [ISO8601-2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates", "example": "1970-11-02" }, "email": { "type": "string", "description": "End-User's preferred e-mail address. Its value MUST conform to the [RFC5322] addr-spec syntax", "example": "jane.doe@email.com" }, "email_verified": { "type": "boolean", "description": "True if the user's email has been verified.", "default": false }, "family_name": { "type": "string", "description": "Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters", "example": "Doe" }, "gender": { "type": "string", "description": "End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable", "example": "female" }, "given_name": { "type": "string", "description": "Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters", "example": "Jane" }, "locale": { "type": "string", "description": "End-User's locale, represented as a [RFC5646] language tag. This is typically an [ISO639-1] language code in lowercase and an [ISO3166-1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US", "example": "en" }, "middle_name": { "type": "string", "description": "Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used", "example": "Mary" }, "name": { "type": "string", "description": "End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences", "example": "Jane Mary Doe" }, "nickname": { "type": "string", "description": "Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael", "example": "JaneDoe" }, "phone_number": { "type": "string", "description": "End-User's preferred telephone number. [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 82) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678", "example": "+1 (425) 555-1212" }, "phone_number_verified": { "type": "boolean", "description": "True if the user's phone number has been verified.", "default": false }, "picture": { "type": "string", "description": "URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User", "example": "https://some.url.com/janeDoe.jpg" }, "preferred_username": { "type": "string", "description": "Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace", "example": "janeDoe" }, "profile": { "type": "string", "description": "URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User", "example": "https://my.blog.com/janeDoe" }, "sub": { "type": "string", "description": "Subject - Unique Identifier for the End-User", "example": "a066ffd5-f685-43bc-ad57-bfb7639decb0" }, "website": { "type": "string", "description": "URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with", "example": "https://janedoe.com" }, "zoneinfo": { "type": "string", "description": "String from zoneinfo time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles", "example": "America/Los_Angeles" }, "address": { "$ref": "#/components/schemas/GeographicAddress" }, "previousAddress": { "$ref": "#/components/schemas/GeographicAddress" }, "legalId": { "type": "array", "description": "Identification documentation of the contact", "items": { "$ref": "#/components/schemas/IndividualIdentification" } }, "userAssets": { "type": "array", "description": "List of additional profile information", "items": { "$ref": "#/components/schemas/UserAsset" } } } }, "EventSubscription": { "required": [ "callback", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "EventSubscriptionInput": { "required": [ "callback" ], "type": "object", "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "Error": { "required": [ "code", "reason" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "status": { "type": "string", "description": "HTTP Error code extension" }, "referenceError": { "type": "string", "description": "URI of documentation describing the error.", "format": "uri" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." } }, "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)" }, "CreditApplicationResult": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a shopping cart - presumably created by a party role and containing one or more product offerings", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "description": "Additional characteristics for which the risk might be assessed, optional input to the task", "items": { "$ref": "#/components/schemas/Characteristic" } }, "place": { "$ref": "#/components/schemas/RelatedPlace" }, "riskAssessmentResult": { "$ref": "#/components/schemas/RiskAssessmentResult" }, "accountDebtDetails": { "type": "array", "description": "Debt details", "items": { "$ref": "#/components/schemas/AccountDebtDetails" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" } }, "required": [ "id", "status" ] }, "RiskAssessmentResult": { "type": "object", "properties": { "overallScore": { "type": "number", "description": "An overall assessment of the risk, composed from the individual scores", "format": "float" }, "score": { "type": "array", "description": "Additional characteristics for which the risk might be assessed, optional input to the task", "items": { "$ref": "#/components/schemas/RiskScore" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" } }, "description": "This resource reflects the risk assessment" }, "RiskScore": { "type": "object", "properties": { "score": { "type": "number", "description": "The risk score", "format": "float" }, "riskName": { "$ref": "#/components/schemas/RiskType" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" } }, "description": "This resource reflects a score for a specific risk" }, "RiskType": { "type": "string", "description": "Types of risk that can be assessed", "enum": [ "FraudRisk", "BadPaymentRisk", "CreditGamingRisk", "IDConfidenceRisk", "PaymentMethodRisk" ] }, "ShoppingCartRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of shopping cart" }, "href": { "type": "string", "description": "Hypertext Reference of the shopping cart." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with." }, "Characteristic": { "required": [ "name", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicRelationship" } }, "value": { "type": "string", "description": "Value of the characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "CharacteristicRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "relationshipType": { "type": "string", "description": "The type of relationship" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "Another Characteristic that is related to the current Characteristic;" }, "RelatedPlace": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role": { "type": "string", "description": "Role of the place, such as: [home delivery], [shop retrieval])" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "A Place and an associated role as installation adress, delivery address, etc...." }, "Any": { "type": "object" }, "CreditVerificationQuestionsResponse": { "type": "object", "properties": { "creditApplicationId": { "type": "string", "description": "Credit Application Id" }, "interConnectTransactionId": { "type": "string", "description": "Transaction Id" }, "unifiedCreditTransactionId": { "type": "string", "description": "Transaction Id" }, "questionAndAnswer": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionAndAnswer" } } } }, "QuestionAndAnswer": { "type": "object", "properties": { "questionId": { "type": "string", "description": "Question id" }, "questionText": { "type": "string", "description": "Question Text" }, "answerOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerOption" } } } }, "AnswerOption": { "type": "object", "properties": { "answerId": { "type": "string", "description": "Question id" }, "answerText": { "type": "string", "description": "Question Text" } } }, "CreditVerificationAnswersRequest": { "type": "object", "properties": { "creditApplicationId": { "type": "string", "description": "Credit Application Id" }, "interConnectTransactionId": { "type": "string", "description": "CAS Inter connect transaction Id" }, "unifiedCreditTransactionId": { "type": "string", "description": "CAS Unified transaction Id" }, "refusedIndicator": { "type": "boolean", "description": "Refused flag" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/Answer" } } } }, "Answer": { "type": "object", "properties": { "questionId": { "type": "string", "description": "Question Id" }, "answerId": { "type": "string", "description": "Answer Id" } } }, "CreditApplicationRequest": { "type": "object", "properties": { "accountDetails": { "$ref": "#/components/schemas/AccountDetails" }, "applicationDetails": { "$ref": "#/components/schemas/ApplicationDetails" }, "userInfo": { "$ref": "#/components/schemas/Userinfo" }, "channel": { "$ref": "#/components/schemas/RelatedChannel" }, "relatedParty": { "$ref": "#/components/schemas/RelatedParty" } } }, "CreditApplicationDisclosureRequest": { "type": "object", "properties": { "accountDetails": { "$ref": "#/components/schemas/AccountDetails" }, "applicationDetails": { "$ref": "#/components/schemas/ApplicationDetails" }, "userInfo": { "$ref": "#/components/schemas/Userinfo" }, "relatedParty": { "$ref": "#/components/schemas/RelatedParty" }, "channel": { "$ref": "#/components/schemas/RelatedChannel" } } }, "CreditApplicationDisclosureResponse": { "type": "object", "properties": { "creditDisclosureRequired": { "type": "boolean", "description": "Disclosure required flag." } } }, "CreditApplicationStatusRequest": { "type": "object", "properties": { "applicationDetails": { "$ref": "#/components/schemas/ApplicationDetails" }, "channel": { "$ref": "#/components/schemas/RelatedChannel" }, "relatedParty": { "$ref": "#/components/schemas/RelatedParty" } } }, "RelatedChannel": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the channel." }, "role": { "type": "string", "description": "Role playing by the channel." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Related channel to another entity. May be online web, mobile app, social ,etc." }, "RelatedParty": { "required": [ "@referredType", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party" }, "extensions": { "$ref": "#/components/schemas/Characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "format": "uri" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Related Entity reference. A related party defines party or party role linked to a specific entity." }, "ApplicationDetails": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a application" }, "unifiedCreditTransactionId": { "type": "string", "description": "Transaction Id." }, "unifiedPolicyTransactionId": { "type": "string", "description": "Unified Policy Transaction Id." }, "refusedIndicator": { "type": "boolean", "description": "Refused Indicator" }, "debtPaymentComplete": { "type": "boolean", "description": "Debt Payment completed part of the transaction" } }, "description": "Credit Application Details" }, "AccountDetails": { "type": "object", "properties": { "accountType": { "type": "string", "description": "Type of the Account." }, "id": { "type": "string", "description": "Billing Account Number" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Existing Account Details" }, "AccountDebtDetails": { "type": "object", "properties": { "billingFullName": { "type": "string", "description": "Billing full name." }, "affiliateAccountNumber": { "type": "string", "description": "Billing Account Number" }, "affiliateId": { "type": "string", "description": "Affiliate ID" }, "accountCategory": { "type": "string", "description": "Account Category Name" }, "debtDetails": { "$ref": "#/components/schemas/DebtDetails" }, "serviceAddress": { "$ref": "#/components/schemas/GeographicAddress" }, "billingAddress": { "$ref": "#/components/schemas/GeographicAddress" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Existing Debt Details" }, "DebtDetails": { "type": "object", "properties": { "accountClass": { "type": "string", "description": "Account Class" }, "accountBalance": { "type": "number", "description": "Account Balance" }, "pastDueAmount": { "type": "number", "description": "Past due amount" }, "minimumAmountDue": { "type": "number", "description": "Minumum Amount Due" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Existing Debt Details" } } } }