RegisterCodiDeviceRequest

{
    "type": "object",
    "properties": {
        "deviceDetails": {
            "$ref": "#/definitions/Device"
        }
    }
}
              

Device

{
    "type": "object",
    "properties": {
        "deviceMake": {
            "description": "Maker of the device which the client is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "samsung"
        },
        "deviceModel": {
            "description": "Model of the device which the client is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "SM-G935F"
        },
        "deviceOsName": {
            "description": "Operative system of the device with the client is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "Android"
        },
        "deviceOsVersion": {
            "description": "Version of the operative system of the device which the user is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "8.0.0"
        },
        "deviceSerialNumber": {
            "description": "Serial number of the device which a new user is enrolling with Citibanamex CoDi",
            "type": "string",
            "example": "12d58955dcd9e1f4-com.citibanamex.banamexmobile"
        },
        "phoneNumber": {
            "description": "CoDi client phone number",
            "type": "string",
            "example": "5512345678"
        }
    },
    "required": [
        "deviceMake",
        "deviceModel",
        "deviceOsName",
        "deviceOsVersion",
        "deviceSerialNumber",
        "phoneNumber"
    ]
}
              

RegisterCodiDeviceResponse

{
    "type": "object",
    "properties": {
        "uniqueCodiCcsId": {
            "description": "CoDi Citibanamex id composed of customer phonenumber and banxico check code",
            "type": "string",
            "example": "5512345678000"
        },
        "encryptedGoogleId": {
            "description": "Encrypted Id of the project enrolled with  Google in order to request a new FirebaseId releated to the project",
            "type": "string",
            "example": ""
        }
    },
    "required": [
        "uniqueCodiCcsId"
    ]
}
              

ValidateCodiCustomerRequest

{
    "type": "object",
    "properties": {
        "firebaseId": {
            "description": "Firebase id of the customer registered with Banxico in order to receive PUSH notifications",
            "type": "string",
            "example": "dUww7Jl4b9o:APA91bGHVzEMF6xdD_ZV1L4CF5ZgrBqDQGl9QO4OIemuIf04sMzbFBl_duDoWZOO4rADGviq0Rf4UCz-cYS6zvijYesfRbUR1a4BQqKUQ4z56cgmTyEjtQdQQgIz_-8KLRxmJdI9571o"
        },
        "uniqueCodiCcsId": {
            "description": "CoDi Citibanamex id composed of customer phonenumber and banxico check code",
            "type": "string",
            "example": "5512345678000"
        },
        "customerId": {
            "description": "Unique identifier for customer holding a Citibanamex Account",
            "type": "string",
            "example": "1098765423718"
        },
        "deviceInfo": {
            "$ref": "#/definitions/DeviceInfo"
        }
    },
    "required": [
        "firebaseId",
        "uniqueCodiCcsId",
        "customerId"
    ]
}
              

DeviceInfo

{
    "type": "object",
    "properties": {
        "deviceMake": {
            "description": "Maker of the device which the client is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "samsung"
        },
        "deviceModel": {
            "description": "Model of the device which the client is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "SM-G935F"
        },
        "deviceOsName": {
            "description": "Operative system of the device with the client is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "Android"
        },
        "deviceOsVersion": {
            "description": "Version of the operative system of the device which the user is using to enroll with Citibanamex CoDi",
            "type": "string",
            "example": "8.0.0"
        },
        "deviceSerialNumber": {
            "description": "Serial number of the device which a new user is enrolling with Citibanamex CoDi",
            "type": "string",
            "example": "12d58955dcd9e1f4-com.citibanamex.banamexmobile"
        }
    },
    "required": [
        "deviceMake",
        "deviceModel",
        "deviceOsName",
        "deviceOsVersion",
        "deviceSerialNumber"
    ]
}
              

ValidateCodiCustomerResponse

{
    "type": "object",
    "properties": {
        "banamexDefaultCodiBankingAppFlag": {
            "description": "Boolean value that determines if the Ctibanamex Mobile App is the default one to use CoDi",
            "type": "boolean",
            "example": true
        }
    },
    "required": [
        "banamexDefaultCodiBankingAppFlag"
    ]
}
              

GenerateKeySourceRequest

{
    "type": "object",
    "properties": {
        "deviceSerialNumber": {
            "description": "Serial number of the device which a new user is enrolling with Citibanamex CoDi",
            "type": "string",
            "example": "12d58955dcd9e1f4-com.citibanamex.banamexmobile"
        },
        "encryptedGoogleId": {
            "description": "Encrypted Id of the project enrolled with  Google in order to request a new FirebaseId releated to the project",
            "type": "string",
            "example": ""
        },
        "oneTimePassword": {
            "description": "OTP numerical value  of 6 digits sent by Banxico through SMS to validate that a customer is enrolling with CoDi Banxico",
            "type": "string",
            "example": "123456"
        },
        "uniqueCodiCcsId": {
            "description": "CoDi Citibanamex id composed of customer phone number and banxico check code",
            "type": "string",
            "example": "5512345678000"
        },
        "customerId": {
            "description": "Unique identifier for customer holding a Citibanamex Account",
            "type": "string",
            "example": "1098765423718"
        }
    },
    "required": [
        "deviceSerialNumber",
        "encryptedGoogleId",
        "oneTimePassword",
        "uniqueCodiCcsId",
        "customerId"
    ]
}
              

GenerateKeySourceResponse

{
    "type": "object",
    "properties": {
        "decryptedGoogleId": {
            "description": "Decrypted Id of the project enrolled with  Google in order to request a new FirebaseId releated to the project",
            "type": "string",
            "example": "dUww7Jl4b9o:APA91bGHVzEMF6xdD_ZV1L4CF5ZgrBqDQGl9QO4OIemuIf04sMzbFBl_duDoWZOO4rADGviq0Rf4UCz-cYS6zvijYesfRbUR1a4BQqKUQ4z56cgmTyEjtQdQQgIz_-8KLRxmJdI9571o"
        }
    },
    "required": [
        "decryptedGoogleId"
    ]
}
              

SetDefaultApplicationRequest

{
    "type": "object",
    "properties": {
        "uniqueCodiCcsId": {
            "description": "CoDi Citibanamex id composed of customer phonenumber and banxico check code",
            "type": "string",
            "example": "5512345678000"
        },
        "customerId": {
            "description": "Unique identifier for customer holding a Citibanamex Account",
            "type": "string",
            "example": "1098765423718"
        }
    },
    "required": [
        "uniqueCodiCcsId",
        "customerId"
    ]
}
              

SetDefaultApplicationResponse

{
    "type": "object",
    "properties": {
        "banamexDefaultCodiBankingAppFlag": {
            "description": "Boolean value that determines if the Citibanamex Mobile App has been setted as the default app for CoDi with Banxico",
            "type": "boolean",
            "example": true
        }
    },
    "required": [
        "banamexDefaultCodiBankingAppFlag"
    ]
}
              

ErrorResponse

{
    "properties": {
        "type": {
            "type": "string",
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "More Info can be used to pass any additional details",
            "type": "string"
        },
        "uuid": {
            "description": "128 bit UUID that you generate for every request",
            "type": "string"
        },
        "timestamp": {
            "description": "Timestamp of the error",
            "type": "string"
        }
    },
    "required": [
        "type",
        "code"
    ]
}