{ "openapi": "3.0.3", "info": { "title": "Moffin API", "description": "# Introduction\n\nMoffin allows you to validate and evaluate the credit profile of your clients in an instant. Consult and automatically evaluate their financial information.\n\nMoffin API is implemented as a [REST API](https://en.wikipedia.org/wiki/Representational_State_Transfer) architecture.\nOur API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.\n\nClick [here](https://guides.moffin.mx) to consult our guides.\n\n# Environments\n\n| Name | Description | Base URL |\n| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |\n| **Sandbox** | The Sandbox environment is dedicated to development and testing. In this environment, no real taxpayer credentials are required and all interaction with the Moffin is simulated generating life-like data, allowing you to pull test data from all endpoints. | https://sandbox.moffin.mx/api/v1 |\n| **Production** | The Production environment is dedicated to the application with real connections to Moffin. In this environment, real client credentials are required and you will get real data through Moffin. | https://app.moffin.mx/api/v1 |\n\nEach environment has a different API Key for authentication.\n\n# Generate access token\n\nGo to the settings panel in Moffin to create an access token.\nGo to 'Configuración' > 'API' > 'Crear nuevo token':\n\n- [Set up token in sandbox](https://sandbox.moffin.mx/configuracion/api)\n- [Set up token in production](https://app.moffin.mx/configuracion/api)\n\nYou can then set the token as shown in this example:\n\n```sh\n curl --location 'https://sandbox.moffin.mx/api/v1/report' \\\n --header 'Authorization: Token $TOKEN'\n```\n\n# Rate limiter\n\nThe server uses a rate limiter that only allow consuming 10 points per second and every request to the server consumes one point for now.\nAfter all points are consumed, every response of the server is a HTTP code 429 (Too many requests) until the points are replenished.\n\nEvery API token has it's own rate limit, but if a token is not supplied, the rate limit is applied to the client IP instead of the token.\n\nAll endpoints include in their response the following headers that give information about the rate limiter state.\n\n|Header|Description|Example|\n|---|---|---|\n|`X-RateLimit-Limit`|The rate limit of the endpoint.|10|\n|`X-RateLimit-Remaining`|The remaining points to consume.|5|\n|`X-RateLimit-Reset`|The Unix Epoch time when the rate limiter will be reseted with milliseconds precission.|1718652450631|\n", "version": "0.1.0" }, "components": { "schemas": { "non-structured-data": { "title": "JSON Schema Validator", "description": "A schema to validate JSON Schemas", "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "oneOf": [ { "type": "string", "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, { "type": "array", "items": { "type": "string", "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "minItems": 2, "maxItems": 2, "uniqueItems": true, "contains": { "enum": [ "null" ] } } ] }, "pattern": { "type": "string", "format": "regex" }, "format": { "type": "string", "enum": [ "uuid", "email", "date-time", "time", "date", "hostname", "uri" ] }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/non-structured-data" } }, "items": { "$ref": "#/components/schemas/non-structured-data" }, "required": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "enum": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "additionalProperties": { "type": "boolean" } }, "additionalProperties": false }, "dataDocumentProfileAssociation": { "title": "Profile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Profiles" ] }, "association": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ], "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, "dataDocumentFormAssociation": { "title": "Form", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Forms" ] }, "association": { "type": "object", "properties": { "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } }, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, "dataDocumentFileAssociation": { "title": "File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Files" ] }, "association": { "type": "object", "properties": { "id": { "type": "integer" }, "uploadedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "number", "nullable": true }, "organizationId": { "type": "integer" }, "filetype": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "filelabel": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "uploaderId": { "type": "integer", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "description": "URL to download the file valid for 24h", "nullable": true }, "previewUrl": { "type": "string", "format": "uri", "description": "URL to preview the file valid for 24h", "nullable": true }, "fileCollectionId": { "type": "integer", "nullable": true, "minimum": 1 }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] } }, "additionalProperties": false, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, "fileProfileAssociation": { "title": "Profile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Profiles" ] }, "association": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ], "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, "fileFormAssociation": { "title": "Form", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Forms" ] }, "association": { "type": "object", "properties": { "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } }, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] } } }, "paths": { "/api/v1/credential/bureau/pm": { "post": { "tags": [ "Credentials" ], "description": "Upsert a credential for the Bureau PM service", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "user": { "type": "string", "pattern": "^[a-zA-Z0-9_]*$" }, "password": { "type": "string", "pattern": "^[a-zA-Z0-9_]*$" } }, "required": [ "user", "password" ] }, "examples": { "payload": { "value": { "user": "XXXXXXXXXX", "password": "xxxxxxxx" } } } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } }, "/api/v1/credential/bureau/pf": { "post": { "summary": "Upsert a credential for the Bureau PF service", "tags": [ "Credentials" ], "description": "The credentials are validate against Buro de Credito", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "user": { "type": "string", "pattern": "^[a-zA-Z0-9_]*$" }, "password": { "type": "string", "pattern": "^[a-zA-Z0-9_]*$", "description": "Use the encrypted password instead of the plain (VPN) password from Buro de Credito" } }, "required": [ "user", "password" ] }, "examples": { "payload": { "value": { "user": "XXXXXXXXXX", "password": "xxxxxxxx" } } } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } }, "/api/v1/credential/prospector/pf": { "post": { "tags": [ "Credentials" ], "description": "Upsert a credential for the Prospector service.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "user": { "type": "string", "pattern": "^[a-zA-Z0-9_]*$" }, "password": { "type": "string", "pattern": "^[a-zA-Z0-9_]*$", "description": "Use the encrypted password instead of the plain (VPN) password from Buro de Credito" } }, "required": [ "user", "password" ] }, "examples": { "payload": { "value": { "user": "XXXXXXXXXX", "password": "xxxxxxxx" } } } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } }, "/api/v1/credential/jumio": { "post": { "tags": [ "Credentials" ], "description": "Upsert a credential for the Jumio service.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "user": { "type": "string" }, "password": { "type": "string" } }, "required": [ "user", "password" ] }, "examples": { "payload": { "description": "The data is not real, it is just an example", "value": { "user": "fA6gzdM4TZR4xMpRpvDDqI66egNMrADA", "password": "lXFB37GBbQ21oU3CwoptdYDEGKd4EEnypFEKyiF2Ru35FpZSFlEoCOQZ5Bn3TgwA" } } } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } }, "/api/v1/credential/comply-advantage": { "post": { "tags": [ "Credentials" ], "description": "Upsert a credential for the Comply Advantage", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "token": { "type": "string" } }, "required": [ "token" ] }, "examples": { "payload": { "description": "The data is not real, it is just an example", "value": { "token": "fA6gzdM4TZR4xMpRpvDDqI66egNMrADA" } } } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } }, "/api/v1/credential/circulo-credito": { "post": { "tags": [ "Credentials" ], "description": "Upsert a credential for the Circulo de Credito service.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "apiKey": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "clientPrivateKey": { "type": "string" }, "cdcPublicKey": { "type": "string" } }, "required": [ "username", "apiKey", "password", "clientPrivateKey", "cdcPublicKey" ] }, "examples": { "payload": { "description": "The data is not real, it is just an example", "value": { "username": "example@example.com", "apiKey": "fA6gzdM4TZR4xMpRpvDDqI66egNMrADA", "password": "Y5tkdm0FfM8leFUyoxL", "clientPrivateKey": "f4548607bd894ced653bc345b6f2981f9cd608d033e2592e2c86c70ccb6522f21b693a223a0b954c2c3a12f2917f1e03", "cdcPublicKey": "1fd604950b192aef510250a90554fbcbf5f375cacf7d130e69b43e7497416c63982fe1c0e5166c702682ad0762a6d5d486d4c2703702190ca4350ca6cb743012aef6f86a3ff15edbe638de6368d631e3b0ea83950b0bbef2367e1e48c491d4c1f9" } } } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } }, "/api/v1/credential/buho-legal": { "post": { "tags": [ "Credentials" ], "description": "Upsert a credential for the Buho legal service.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ] }, "examples": { "payload": { "description": "The data is not real, it is just an example", "value": { "username": "example@example.com", "password": "ClOuQo8plS" } } } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } }, "/api/v1/credential": { "get": { "summary": "Get all credentials", "tags": [ "Credentials" ], "description": "Return all credentials for the organization", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "organizationId": { "type": "number" }, "type": { "type": "string" }, "user": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "expirationDate": { "type": "string", "format": "date", "nullable": true, "description": "The expiration date only applies to the bureau services" } } }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "isAutoRenewEnabled": { "type": "boolean", "description": "This flag only applies to the bureau PF service" } } }, "isEnabled": { "type": "boolean" }, "ownerId": { "type": "number", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "organizationId", "type", "isEnabled" ] } } } } } } } }, "/api/v1/data/collection/tags": { "get": { "tags": [ "data" ], "description": "Get unique data collection tags for organization", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" }, "data": { "type": "array", "items": { "type": "string" } } }, "required": [ "count", "data" ], "additionalProperties": false } } } } } } }, "/api/v1/data/collection": { "get": { "tags": [ "data" ], "description": "Get data collections (Beta)", "parameters": [ { "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 10 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "number", "minimum": 0, "default": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeActiveDataCollectionVersion", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeCreator", "required": false, "description": "Include the creator of the data collection. Also the creator of the current version if the flag `includeActiveDataCollectionVersion` is enabled" }, { "schema": { "type": "object", "properties": { "name__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact name." }, "name__like": { "type": "string", "description": "Filter using complete or part the text searching specified fields(name)." }, "organizationId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact organizationId." }, "parentCollectionId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact parentCollectionId." }, "activeDataCollectionVersionId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact activeDataCollectionVersionId." }, "tags__anyOf": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by any of the specified tags." }, "tags__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact tags." }, "processorKey__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact processorKey." } } }, "in": "query", "name": "filter", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "creatorId": { "type": "integer" }, "creator": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string", "enum": [ "admin", "member", "base" ] } } }, "activeDataCollectionVersionId": { "type": "number" }, "activeDataCollectionVersion": { "nullable": true, "type": "object", "properties": { "id": { "type": "integer" }, "schema": { "type": "object", "additionalProperties": true }, "creatorId": { "type": "integer" }, "creator": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string", "enum": [ "admin", "member", "base" ] } } }, "createdAt": { "type": "string", "format": "date-time" }, "dataCollectionId": { "type": "integer" }, "organizationId": { "type": "integer" } }, "required": [ "id", "schema", "creatorId", "createdAt", "dataCollectionId", "organizationId" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "nullable": false, "minLength": 1 }, "parentCollectionId": { "type": "integer", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "processorKey": { "type": "string", "nullable": true } }, "required": [ "id", "name", "activeDataCollectionVersionId", "creatorId", "tags" ], "additionalProperties": false } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "data", "total" ] } } } } } } }, "/api/v1/data/collection/{id}": { "get": { "tags": [ "data" ], "description": "Get data collection by id (Beta)", "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "creatorId": { "type": "integer" }, "creator": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string", "enum": [ "admin", "member", "base" ] } } }, "activeDataCollectionVersionId": { "type": "number" }, "activeDataCollectionVersion": { "nullable": true, "type": "object", "properties": { "id": { "type": "integer" }, "schema": { "type": "object", "additionalProperties": true }, "creatorId": { "type": "integer" }, "creator": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string", "enum": [ "admin", "member", "base" ] } } }, "createdAt": { "type": "string", "format": "date-time" }, "dataCollectionId": { "type": "integer" }, "organizationId": { "type": "integer" } }, "required": [ "id", "schema", "creatorId", "createdAt", "dataCollectionId", "organizationId" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "nullable": false, "minLength": 1 }, "parentCollectionId": { "type": "integer", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "processorKey": { "type": "string", "nullable": true } }, "required": [ "id", "name", "activeDataCollectionVersionId", "creatorId", "tags" ], "additionalProperties": false } } } } } } }, "/api/v1/data/collection/{id}/versions": { "get": { "tags": [ "data" ], "description": "Get all versions of a data collection (Beta)", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "default": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" }, "creatorId": { "type": "integer" }, "isActive": { "type": "boolean" }, "schema": { "title": "JSON Schema Validator", "description": "A schema to validate JSON Schemas", "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "oneOf": [ { "type": "string", "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, { "type": "array", "items": { "type": "string", "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "minItems": 2, "maxItems": 2, "uniqueItems": true, "contains": { "enum": [ "null" ] } } ] }, "pattern": { "type": "string", "format": "regex" }, "format": { "type": "string", "enum": [ "uuid", "email", "date-time", "time", "date", "hostname", "uri" ] }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/non-structured-data" } }, "items": { "$ref": "#/components/schemas/non-structured-data" }, "required": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "enum": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "additionalProperties": { "type": "boolean" } }, "additionalProperties": false } }, "required": [ "id", "createdAt", "creatorId", "isActive", "schema" ], "additionalProperties": false } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "data", "total" ] } } } } } } }, "/api/v1/data/document/tags": { "get": { "tags": [ "data" ], "description": "Get unique data document tags for organization", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" }, "data": { "type": "array", "items": { "type": "string" } } }, "required": [ "count", "data" ], "additionalProperties": false } } } } } } }, "/api/v1/data/collection/{collectionId}/document": { "get": { "tags": [ "data" ], "description": "Get a data document by collection (Beta)", "parameters": [ { "schema": { "type": "integer", "minimum": 10, "maximum": 100, "default": 50 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "default": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "boolean", "default": false }, "in": "query", "name": "includeDataDocumentAssociations", "required": false }, { "schema": { "type": "boolean", "default": false }, "in": "query", "name": "includeProfileAssociation", "required": false }, { "schema": { "type": "boolean", "default": false }, "in": "query", "name": "includeFormAssociation", "required": false }, { "schema": { "type": "boolean", "default": false }, "in": "query", "name": "includeFileAssociation", "required": false }, { "schema": { "type": "string", "enum": [ "-document.createdAt", "document.createdAt" ], "nullable": true }, "in": "query", "name": "order", "required": false, "description": "Order by createdAt field. A minus(-) means that we'll order the documents in descending order." }, { "schema": { "type": "number" }, "in": "path", "name": "collectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "externalId": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "document": { "type": "object", "additionalProperties": true }, "dataCollectionVersionId": { "type": "number" }, "dataCollectionId": { "type": "number" }, "creatorId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "associations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } }, "discriminator": { "propertyName": "type", "mapping": { "Profiles": "#/components/schemas/dataDocumentProfileAssociation", "Forms": "#/components/schemas/dataDocumentFormAssociation", "Files": "#/components/schemas/dataDocumentFileAssociation" } }, "oneOf": [ { "title": "Profile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Profiles" ] }, "association": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ], "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "Form", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Forms" ] }, "association": { "type": "object", "properties": { "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } }, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Files" ] }, "association": { "type": "object", "properties": { "id": { "type": "integer" }, "uploadedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "number", "nullable": true }, "organizationId": { "type": "integer" }, "filetype": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "filelabel": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "uploaderId": { "type": "integer", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "description": "URL to download the file valid for 24h", "nullable": true }, "previewUrl": { "type": "string", "format": "uri", "description": "URL to preview the file valid for 24h", "nullable": true }, "fileCollectionId": { "type": "integer", "nullable": true, "minimum": 1 }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] } }, "additionalProperties": false, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] } ], "required": [ "type" ] } } }, "additionalProperties": false, "required": [ "id", "document", "dataCollectionVersionId", "creatorId", "externalId", "createdAt", "updatedAt", "tags" ] } } }, "required": [ "total", "documents" ], "additionalProperties": false } } } } } } }, "/api/v1/data/document/{id}": { "get": { "tags": [ "data" ], "description": "Get a data document by id (Beta)", "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "externalId": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "document": { "type": "object", "additionalProperties": true }, "dataCollectionVersionId": { "type": "number" }, "dataCollectionId": { "type": "number" }, "creatorId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "associations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } }, "discriminator": { "propertyName": "type", "mapping": { "Profiles": "#/components/schemas/dataDocumentProfileAssociation", "Forms": "#/components/schemas/dataDocumentFormAssociation", "Files": "#/components/schemas/dataDocumentFileAssociation" } }, "oneOf": [ { "title": "Profile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Profiles" ] }, "association": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ], "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "Form", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Forms" ] }, "association": { "type": "object", "properties": { "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } }, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Files" ] }, "association": { "type": "object", "properties": { "id": { "type": "integer" }, "uploadedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "number", "nullable": true }, "organizationId": { "type": "integer" }, "filetype": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "filelabel": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "uploaderId": { "type": "integer", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "description": "URL to download the file valid for 24h", "nullable": true }, "previewUrl": { "type": "string", "format": "uri", "description": "URL to preview the file valid for 24h", "nullable": true }, "fileCollectionId": { "type": "integer", "nullable": true, "minimum": 1 }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] } }, "additionalProperties": false, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] } ], "required": [ "type" ] } } }, "additionalProperties": false, "required": [ "id", "document", "dataCollectionVersionId", "creatorId", "externalId", "createdAt", "updatedAt", "tags" ] } } } } } } }, "/api/v1/data/document": { "get": { "tags": [ "data" ], "description": "Get data documents (Beta)", "parameters": [ { "schema": { "type": "integer", "minimum": 10, "maximum": 100, "default": 50 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "default": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "-document.createdAt", "document.createdAt" ], "nullable": true }, "in": "query", "name": "order", "required": false, "description": "Order by createdAt field. A minus(-) means that we'll order the documents in descending order." } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "externalId": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "document": { "type": "object", "additionalProperties": true }, "dataCollectionVersionId": { "type": "number" }, "dataCollectionId": { "type": "number" }, "creatorId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "associations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } }, "discriminator": { "propertyName": "type", "mapping": { "Profiles": "#/components/schemas/dataDocumentProfileAssociation", "Forms": "#/components/schemas/dataDocumentFormAssociation", "Files": "#/components/schemas/dataDocumentFileAssociation" } }, "oneOf": [ { "title": "Profile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Profiles" ] }, "association": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ], "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "Form", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Forms" ] }, "association": { "type": "object", "properties": { "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } }, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Files" ] }, "association": { "type": "object", "properties": { "id": { "type": "integer" }, "uploadedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "number", "nullable": true }, "organizationId": { "type": "integer" }, "filetype": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "filelabel": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "uploaderId": { "type": "integer", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "description": "URL to download the file valid for 24h", "nullable": true }, "previewUrl": { "type": "string", "format": "uri", "description": "URL to preview the file valid for 24h", "nullable": true }, "fileCollectionId": { "type": "integer", "nullable": true, "minimum": 1 }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] } }, "additionalProperties": false, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] } ], "required": [ "type" ] } } }, "additionalProperties": false, "required": [ "id", "document", "dataCollectionVersionId", "creatorId", "externalId", "createdAt", "updatedAt", "tags" ] } } }, "required": [ "total", "documents" ], "additionalProperties": false } } } } } } }, "/api/v1/data/document/{associationType}/{associationId}": { "get": { "tags": [ "data" ], "description": "Get a data document by association (Beta)", "parameters": [ { "schema": { "type": "object", "properties": { "dataCollectionId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact dataCollectionId." }, "dataCollectionId__gt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by dataCollectionId greater than specified value." }, "dataCollectionId__gte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by dataCollectionId less than specified value." }, "dataCollectionId__lt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by dataCollectionId less than specified value." }, "dataCollectionId__lte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by dataCollectionId less than specified value." }, "dataCollectionId__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified dataCollectionId." }, "tags__anyOf": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by any of the specified tags." }, "tags__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact tags." } } }, "in": "query", "name": "filter", "required": false }, { "schema": { "type": "string", "enum": [ "-document.createdAt", "document.createdAt" ], "nullable": true }, "in": "query", "name": "order", "required": false, "description": "Order by createdAt field. A minus(-) means that we'll order the documents in descending order." }, { "schema": { "type": "string", "enum": [ "forms", "profiles", "service_query", "file" ] }, "in": "path", "name": "associationType", "required": true }, { "schema": { "type": "number" }, "in": "path", "name": "associationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "externalId": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "document": { "type": "object", "additionalProperties": true }, "dataCollectionVersionId": { "type": "number" }, "dataCollectionId": { "type": "number" }, "creatorId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "associations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" } }, "discriminator": { "propertyName": "type", "mapping": { "Profiles": "#/components/schemas/dataDocumentProfileAssociation", "Forms": "#/components/schemas/dataDocumentFormAssociation", "Files": "#/components/schemas/dataDocumentFileAssociation" } }, "oneOf": [ { "title": "Profile", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Profiles" ] }, "association": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ], "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "Form", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Forms" ] }, "association": { "type": "object", "properties": { "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } }, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] }, { "title": "File", "type": "object", "properties": { "type": { "type": "string", "enum": [ "Files" ] }, "association": { "type": "object", "properties": { "id": { "type": "integer" }, "uploadedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "number", "nullable": true }, "organizationId": { "type": "integer" }, "filetype": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "filelabel": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "uploaderId": { "type": "integer", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "description": "URL to download the file valid for 24h", "nullable": true }, "previewUrl": { "type": "string", "format": "uri", "description": "URL to preview the file valid for 24h", "nullable": true }, "fileCollectionId": { "type": "integer", "nullable": true, "minimum": 1 }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] } }, "additionalProperties": false, "nullable": true } }, "additionalProperties": false, "required": [ "type", "association" ] } ], "required": [ "type" ] } } }, "additionalProperties": false, "required": [ "id", "document", "dataCollectionVersionId", "creatorId", "externalId", "createdAt", "updatedAt", "tags" ] } } }, "required": [ "total", "documents" ], "additionalProperties": false } } } } } } }, "/api/v1/evaluations": { "get": { "tags": [ "evaluations" ], "description": "Get evaluations with pagination", "parameters": [ { "schema": { "type": "integer", "minimum": 10, "maximum": 2000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "DESC", "ASC" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "formId", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "profileId", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "hideDuplicates", "required": false }, { "schema": { "type": "string", "enum": [ "PASS", "FAIL" ] }, "in": "query", "name": "status", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "evaluationRuleId": { "type": "integer" }, "formId": { "type": "integer" }, "profileId": { "type": "integer" }, "output": { "type": "object", "properties": { "evaluationRuleId": { "type": "integer" }, "results": { "type": "array" }, "status": { "type": "string" } } }, "status": { "type": "string", "enum": [ "PASS", "FAIL" ] }, "EvaluationRule": { "type": "object", "properties": { "id": { "type": "integer" }, "formConfigId": { "type": "integer" }, "rules": { "type": "object" }, "name": { "type": "string" }, "slug": { "type": "string" } } } } } } } } } } } } } }, "/api/v1/files/upload": { "post": { "tags": [ "Files" ], "requestBody": { "content": { "application/json": { "schema": { "title": "File Schema", "type": "object", "properties": { "associations": { "type": "array", "description": "The entities to associate the file. If you specify more than once the same association type, only the first association is applied.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Forms", "Profiles" ] }, "id": { "type": "integer" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "type": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ], "description": "The file type." }, "externalId": { "type": "string", "description": "Optional external reference or ID." }, "filelabel": { "type": "string", "description": "An identifier for the file, for display purposes. (example: 'Estado de Cuenta')" }, "originalFilename": { "type": "string", "description": "The name of the file (example: 'EstadoDeCuenta.jpg')." }, "size": { "type": "integer", "description": "Maximum file size in bytes. If not provided, the default limit from the organization plan is used." }, "fileCollectionId": { "type": "integer", "description": "The ID of the collection to link the file. If this field is provided the field `parentFileCollectionId` is ignored." }, "parentFileCollectionId": { "type": "integer", "description": "The ID of the parent collection to link the file. Internally link the file to the installed collection in the scoped of the organization." } }, "required": [ "type", "filelabel" ], "additionalProperties": false } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "title": "Upload URL Schema", "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the file." }, "uploadURL": { "type": "string", "description": "The URL to upload the file." }, "uploadFields": { "description": "Those fields should be sent as form-data to the uploadURL. Additional you should send the file as a binary with the key \"file\".", "type": "object", "additionalProperties": true } }, "required": [ "uploadURL", "uploadFields", "id" ], "additionalProperties": false } } } } } } }, "/api/v1/form/{formConfigId}": { "post": { "tags": [ "form" ], "description": "Endpoint to create new form", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "type": "object", "title": "Persona Física", "properties": { "phone": { "type": "string", "description": "In prospector PF service, if the number is not Mexican, it is omitted in the service", "PhoneValidator": { "allowNull": false } }, "email": { "type": "string", "format": "email" }, "nationality": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "description": "Use ISO 3166-1 alpha-2 codes for the nationality country" }, "address": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "address2": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "exteriorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "interiorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "nullable": true, "description": "Use ISO 3166-1:MX codes for state" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "country": { "type": "string", "enum": [ "MX" ] }, "municipality": { "type": "string" }, "extraInformation": { "type": "string", "maxLength": 1024, "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "monthlyIncome": { "type": "integer", "minimum": 0, "nullable": true }, "loanAmount": { "type": "integer", "minimum": 1, "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accountType": { "type": "string", "enum": [ "PF" ] }, "firstName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "rfc": { "type": "string", "description": "RFC for \"Persona Fisica\" forms should have a length of 10 or 13 characters, and letters should be uppercase. \"Homoclave\" can be optional or required, depending on the form configuration" }, "curp": { "type": "string", "pattern": "^([A-Z][AEIOUX][A-Z]{2}\\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\\d|3[01])[HM](?:AS|B[CS]|C[CLMSH]|D[FG]|G[TR]|HG|JC|M[CNS]|N[ETL]|OC|PL|Q[TR]|S[PLR]|T[CSL]|VZ|YN|ZS)[B-DF-HJ-NP-TV-Z]{3}[A-Z\\d])(\\d)$" }, "birthdate": { "type": "string", "format": "date", "formatMaximum": "2020-01-01" } }, "required": [ "email", "phone", "accountType" ] }, { "type": "object", "title": "Persona Moral", "properties": { "phone": { "type": "string", "description": "In prospector PF service, if the number is not Mexican, it is omitted in the service", "PhoneValidator": { "allowNull": false } }, "email": { "type": "string", "format": "email" }, "nationality": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "description": "Use ISO 3166-1 alpha-2 codes for the nationality country" }, "address": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "address2": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "exteriorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "interiorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "nullable": true, "description": "Use ISO 3166-1:MX codes for state" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "country": { "type": "string", "enum": [ "MX" ] }, "municipality": { "type": "string" }, "extraInformation": { "type": "string", "maxLength": 1024, "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "monthlyIncome": { "type": "integer", "minimum": 0, "nullable": true }, "loanAmount": { "type": "integer", "minimum": 1, "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accountType": { "type": "string", "enum": [ "PM" ] }, "tradeName": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "rfc": { "type": "string", "description": "RFC for \"Persona Moral\" forms should have a length of 9 or 12 characters, and letters should be uppercase. \"Homoclave\" can be optional or required, depending on the form configuration" } }, "required": [ "email", "phone", "accountType" ] } ] } } } }, "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, "in": "path", "name": "formConfigId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "formId": { "type": "integer" } } } } } } } } }, "/api/v1/form/{formId}": { "patch": { "tags": [ "form" ], "description": "Endpoint to update an existing form", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "type": "object", "title": "Persona Física", "properties": { "phone": { "type": "string", "description": "In prospector PF service, if the number is not Mexican, it is omitted in the service", "PhoneValidator": { "allowNull": false } }, "email": { "type": "string", "format": "email" }, "nationality": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "description": "Use ISO 3166-1 alpha-2 codes for the nationality country" }, "address": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "address2": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "exteriorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "interiorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "nullable": true, "description": "Use ISO 3166-1:MX codes for state" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "country": { "type": "string", "enum": [ "MX" ] }, "municipality": { "type": "string" }, "extraInformation": { "type": "string", "maxLength": 1024, "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "monthlyIncome": { "type": "integer", "minimum": 0, "nullable": true }, "loanAmount": { "type": "integer", "minimum": 1, "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accountType": { "type": "string", "enum": [ "PF" ] }, "firstName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "rfc": { "type": "string", "description": "RFC for \"Persona Fisica\" forms should have a length of 10 or 13 characters, and letters should be uppercase. \"Homoclave\" can be optional or required, depending on the form configuration", "nullable": true }, "curp": { "type": "string", "pattern": "^([A-Z][AEIOUX][A-Z]{2}\\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\\d|3[01])[HM](?:AS|B[CS]|C[CLMSH]|D[FG]|G[TR]|HG|JC|M[CNS]|N[ETL]|OC|PL|Q[TR]|S[PLR]|T[CSL]|VZ|YN|ZS)[B-DF-HJ-NP-TV-Z]{3}[A-Z\\d])(\\d)$", "nullable": true }, "birthdate": { "type": "string", "format": "date", "formatMaximum": "2020-01-01" } } }, { "type": "object", "title": "Persona Moral", "properties": { "phone": { "type": "string", "description": "In prospector PF service, if the number is not Mexican, it is omitted in the service", "PhoneValidator": { "allowNull": false } }, "email": { "type": "string", "format": "email" }, "nationality": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "description": "Use ISO 3166-1 alpha-2 codes for the nationality country" }, "address": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "address2": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "exteriorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "interiorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "nullable": true, "description": "Use ISO 3166-1:MX codes for state" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "country": { "type": "string", "enum": [ "MX" ] }, "municipality": { "type": "string" }, "extraInformation": { "type": "string", "maxLength": 1024, "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "monthlyIncome": { "type": "integer", "minimum": 0, "nullable": true }, "loanAmount": { "type": "integer", "minimum": 1, "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accountType": { "type": "string", "enum": [ "PM" ] }, "tradeName": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "rfc": { "type": "string", "description": "RFC for \"Persona Moral\" forms should have a length of 9 or 12 characters, and letters should be uppercase. \"Homoclave\" can be optional or required, depending on the form configuration", "nullable": true } } } ] } } } }, "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, "in": "path", "name": "formId", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/form/submit/{formId}": { "post": { "tags": [ "form" ], "description": "Endpoint to submit a form", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validateNIPAuthentication": { "type": "boolean", "default": true } } } } } }, "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, "in": "path", "name": "formId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "403": { "description": "Form has already been completed before", "content": { "application/json": { "schema": { "type": "object", "description": "Form has already been completed before", "properties": { "statusCode": { "type": "number", "enum": [ 403 ] }, "error": { "type": "string", "enum": [ "Forbidden" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } } } } }, "/api/v1/form/nip/validate/{formId}": { "post": { "tags": [ "form" ], "description": "Endpoint to validate a NIP from a form", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "nip": { "type": "string", "pattern": "^\\d{4}$" } } } } } }, "responses": { "204": { "description": "Default Response" }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "401": { "description": "Error thrown if the user is not authorized to do this", "content": { "application/json": { "schema": { "type": "object", "description": "Error thrown if the user is not authorized to do this", "title": "Unauthorized", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 401 ] }, "description": { "type": "string" } } } } } }, "409": { "description": "The form is already submitted", "content": { "application/json": { "schema": { "type": "object", "description": "The form is already submitted", "title": "Conflict", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 409 ] }, "description": { "type": "string" } } } } } } } } }, "/api/v1/form/nip/send-sms/{formId}": { "post": { "tags": [ "form" ], "description": "Endpoint to send sms to verify phone in form", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationName": { "type": "string", "description": "Organization name that will be used when sending SMS" } } } } } }, "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, "in": "path", "name": "formId", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/form/nip/send-email/{formId}": { "post": { "tags": [ "form" ], "description": "Endpoint to send email to verify in form", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationName": { "type": "string", "description": "Organization name that will be used when sending SMS" } } } } } }, "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, "in": "path", "name": "formId", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/form/{formId}/answers/{slug}/file/commit": { "post": { "tags": [ "form" ], "description": "Endpoint to update the file associated with a custom answer in the form", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "newFileId": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, "in": "path", "name": "formId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "title": "", "type": "object", "properties": { "value": { "type": "object", "properties": { "fileId": { "type": "integer" }, "fileName": { "type": "string" }, "associationId": { "type": "integer" }, "replaced": { "type": "boolean" } } } } } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "401": { "description": "Error thrown if the user is not authorized to do this", "content": { "application/json": { "schema": { "type": "object", "description": "Error thrown if the user is not authorized to do this", "title": "Unauthorized", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "integer", "enum": [ 401 ] }, "description": { "type": "string" } } } } } }, "404": { "description": "Thrown if the form, file or the specified slug is not found", "content": { "application/json": { "schema": { "type": "object", "description": "Thrown if the form, file or the specified slug is not found", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "integer", "enum": [ 404 ] }, "description": { "type": "string" } } } } } } } } }, "/api/v1/formconfigs/{id}": { "get": { "tags": [ "formconfigs" ], "description": "Retrieve form config", "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "includeDetailedTags", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeCustomPagesConfig", "required": false }, { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PM", "PF" ] }, "formCompletedURL": { "type": "string", "format": "url", "nullable": true }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "maxLength": 200 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "nip": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "isActive": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isAutoredirectEnabled": { "type": "boolean" }, "rfc": { "type": "object", "properties": { "homoclave": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } } } }, "curp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "income": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "loanAmount": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "steps": { "type": "object", "properties": { "title": { "type": "string" } } }, "general": { "type": "object", "properties": { "termsAndConditions": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } }, "privacyPolicies": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } } } }, "sections": { "type": "object", "properties": { "bureauQueryAuthorization": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "generalInfo": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "start": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "thanks": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "submit": { "type": "string" }, "isImageEnabled": { "type": "boolean" } } } } }, "retryTimeouts": { "type": "object", "properties": { "sms": { "type": "number", "minimum": 35 }, "email": { "type": "number", "minimum": 35 } } }, "tokenDurationDays": { "type": "number", "minimum": 1, "maximum": 30, "nullable": true } } }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "integer" }, "customPagesConfig": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "formConfigId": { "type": "integer" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 1, "maxLength": 256, "type": "string" }, "component": { "minLength": 3, "maxLength": 256, "type": "string", "enum": [ "Select", "TextArea", "TextInput", "Radio", "File", "Checkbox" ] }, "isRequired": { "type": "boolean", "default": false }, "config": { "type": "object", "additionalProperties": true, "description": "The schema of the config depends on the component type" }, "section": { "type": "string" } }, "additionalProperties": false, "allOf": [ { "if": { "type": "object", "properties": { "component": { "enum": [ "Radio" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1 } }, "required": [ "options" ] } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "Select" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1 } }, "required": [ "options" ] } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "TextInput" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "minLength": { "type": "integer", "minimum": 0, "maximum": 1024, "default": 0 }, "maxLength": { "type": "integer", "minimum": 1, "maximum": 1024, "default": 256 }, "matchRegEx": { "type": "string", "format": "regex", "default": null, "nullable": true } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "TextArea" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "minLength": { "type": "integer", "minimum": 0, "maximum": 16384, "default": 0 }, "maxLength": { "type": "integer", "minimum": 1, "maximum": 16384, "default": 256 }, "matchRegEx": { "type": "string", "format": "regex", "default": null, "nullable": true } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "File" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 256 }, "fileCollectionId": { "type": "integer", "default": null, "nullable": true }, "parentFileCollectionId": { "type": "integer", "default": null, "nullable": true }, "fileType": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "maxSize": { "type": "integer", "default": null, "nullable": true, "maximum": 50000000, "description": "Maximum size of 50MB" } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "Checkbox" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1, "maxItems": 20 }, "maxSelections": { "type": "integer", "default": null, "nullable": true, "minimum": 1, "maximum": 20 }, "minSelections": { "type": "integer", "default": 1, "minimum": 1, "maximum": 20 } }, "required": [ "options" ], "additionalProperties": false } } } } ], "required": [ "label", "slug", "component", "config" ] }, "minItems": 1 }, "pages": { "type": "object", "additionalProperties": false, "properties": { "beforeGeneralInformation": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "descriptionPage": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 3, "maxLength": 256, "type": "string" } } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "minItems": 1, "maxItems": 20 }, "submitButton": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" } } } } } }, "afterGeneralInformation": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "descriptionPage": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 3, "maxLength": 256, "type": "string" } } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "minItems": 1, "maxItems": 20 }, "submitButton": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" } } } } } } } } } }, "serviceQueries": { "type": "object", "additionalProperties": false, "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "jumioIdValidation": { "type": "boolean" }, "circuloCreditoPF": { "type": "boolean" }, "caBlacklist": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } } } } } } } } }, "patch": { "tags": [ "formconfigs" ], "description": "Edit form config", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "formCompletedURL": { "type": "string", "format": "url", "nullable": true }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "maxLength": 200 }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "nip": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "isActive": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isAutoredirectEnabled": { "type": "boolean" }, "rfc": { "type": "object", "properties": { "homoclave": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } } } }, "curp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "income": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "loanAmount": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "steps": { "type": "object", "properties": { "title": { "type": "string" } } }, "general": { "type": "object", "properties": { "termsAndConditions": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } }, "privacyPolicies": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } } } }, "sections": { "type": "object", "properties": { "bureauQueryAuthorization": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "generalInfo": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "start": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "thanks": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "submit": { "type": "string" }, "isImageEnabled": { "type": "boolean" } } } } }, "retryTimeouts": { "type": "object", "properties": { "sms": { "type": "number", "minimum": 35 }, "email": { "type": "number", "minimum": 35 } } }, "tokenDurationDays": { "type": "number", "minimum": 1, "maximum": 30, "nullable": true } } }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "serviceQueries": { "type": "object", "additionalProperties": false, "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "jumioIdValidation": { "type": "boolean" }, "circuloCreditoPF": { "type": "boolean" }, "caBlacklist": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean", "additionalProperties": false } } } } }, { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "formCompletedURL": { "type": "string", "format": "url", "nullable": true }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "maxLength": 200 }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "nip": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "isActive": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isAutoredirectEnabled": { "type": "boolean" }, "rfc": { "type": "object", "properties": { "homoclave": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } } } }, "curp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "income": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "loanAmount": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "steps": { "type": "object", "properties": { "title": { "type": "string" } } }, "general": { "type": "object", "properties": { "termsAndConditions": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } }, "privacyPolicies": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } } } }, "sections": { "type": "object", "properties": { "bureauQueryAuthorization": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "generalInfo": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "start": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "thanks": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "submit": { "type": "string" }, "isImageEnabled": { "type": "boolean" } } } } }, "retryTimeouts": { "type": "object", "properties": { "sms": { "type": "number", "minimum": 35 }, "email": { "type": "number", "minimum": 35 } } }, "tokenDurationDays": { "type": "number", "minimum": 1, "maximum": 30, "nullable": true } } }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "serviceQueries": { "type": "object", "additionalProperties": false, "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "jumioIdValidation": { "type": "boolean" }, "circuloCreditoPF": { "type": "boolean" }, "caBlacklist": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean", "additionalProperties": false } } } } } ] }, "examples": { "PM": { "value": { "name": "PM form", "slug": "pm-form", "serviceQueries": { "bureauPM": true, "satBlackList": true, "satRFC": true }, "configuration": { "isPublic": true, "isActive": true }, "formCompletedUrl": "https://moffin.mx/" } }, "PF": { "value": { "name": "PF form", "slug": "pf-form", "serviceQueries": { "bureauPM": true, "bureauPF": true, "renapoCURP": true }, "configuration": { "isPublic": true, "isActive": true }, "formCompletedUrl": "https://moffin.mx/" } } } } } }, "parameters": [ { "schema": { "type": "number", "minimum": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "204": { "description": "Default Response" } } } }, "/api/v1/formconfigs": { "get": { "tags": [ "formconfigs" ], "description": "Retrive form configs with pagination", "parameters": [ { "schema": { "type": "integer", "minimum": 10, "maximum": 2000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "DESC", "ASC" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "additionalProperties": false, "type": "boolean" }, "in": "query", "name": "includeDetailedTags", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PM", "PF" ] }, "formCompletedURL": { "type": "string", "format": "url", "nullable": true }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "maxLength": 200 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "nip": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "isActive": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isAutoredirectEnabled": { "type": "boolean" }, "rfc": { "type": "object", "properties": { "homoclave": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } } } }, "curp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "income": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "loanAmount": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "steps": { "type": "object", "properties": { "title": { "type": "string" } } }, "general": { "type": "object", "properties": { "termsAndConditions": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } }, "privacyPolicies": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } } } }, "sections": { "type": "object", "properties": { "bureauQueryAuthorization": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "generalInfo": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "start": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "thanks": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "submit": { "type": "string" }, "isImageEnabled": { "type": "boolean" } } } } }, "retryTimeouts": { "type": "object", "properties": { "sms": { "type": "number", "minimum": 35 }, "email": { "type": "number", "minimum": 35 } } }, "tokenDurationDays": { "type": "number", "minimum": 1, "maximum": 30, "nullable": true } } }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "integer" }, "customPagesConfig": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "formConfigId": { "type": "integer" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 1, "maxLength": 256, "type": "string" }, "component": { "minLength": 3, "maxLength": 256, "type": "string", "enum": [ "Select", "TextArea", "TextInput", "Radio", "File", "Checkbox" ] }, "isRequired": { "type": "boolean", "default": false }, "config": { "type": "object", "additionalProperties": true, "description": "The schema of the config depends on the component type" }, "section": { "type": "string" } }, "additionalProperties": false, "allOf": [ { "if": { "type": "object", "properties": { "component": { "enum": [ "Radio" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1 } }, "required": [ "options" ] } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "Select" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1 } }, "required": [ "options" ] } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "TextInput" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "minLength": { "type": "integer", "minimum": 0, "maximum": 1024, "default": 0 }, "maxLength": { "type": "integer", "minimum": 1, "maximum": 1024, "default": 256 }, "matchRegEx": { "type": "string", "format": "regex", "default": null, "nullable": true } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "TextArea" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "minLength": { "type": "integer", "minimum": 0, "maximum": 16384, "default": 0 }, "maxLength": { "type": "integer", "minimum": 1, "maximum": 16384, "default": 256 }, "matchRegEx": { "type": "string", "format": "regex", "default": null, "nullable": true } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "File" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 256 }, "fileCollectionId": { "type": "integer", "default": null, "nullable": true }, "parentFileCollectionId": { "type": "integer", "default": null, "nullable": true }, "fileType": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "maxSize": { "type": "integer", "default": null, "nullable": true, "maximum": 50000000, "description": "Maximum size of 50MB" } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "Checkbox" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1, "maxItems": 20 }, "maxSelections": { "type": "integer", "default": null, "nullable": true, "minimum": 1, "maximum": 20 }, "minSelections": { "type": "integer", "default": 1, "minimum": 1, "maximum": 20 } }, "required": [ "options" ], "additionalProperties": false } } } } ], "required": [ "label", "slug", "component", "config" ] }, "minItems": 1 }, "pages": { "type": "object", "additionalProperties": false, "properties": { "beforeGeneralInformation": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "descriptionPage": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 3, "maxLength": 256, "type": "string" } } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "minItems": 1, "maxItems": 20 }, "submitButton": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" } } } } } }, "afterGeneralInformation": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "descriptionPage": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 3, "maxLength": 256, "type": "string" } } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "minItems": 1, "maxItems": 20 }, "submitButton": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" } } } } } } } } } }, "serviceQueries": { "type": "object", "additionalProperties": false, "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "jumioIdValidation": { "type": "boolean" }, "circuloCreditoPF": { "type": "boolean" }, "caBlacklist": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } } } } }, "total": { "type": "number" } } } } } } } }, "post": { "tags": [ "formconfigs" ], "description": "Create form config", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "type": "object", "title": "PM", "properties": { "name": { "type": "string" }, "formCompletedURL": { "type": "string", "format": "url", "nullable": true }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "maxLength": 200 }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "nip": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "isActive": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isAutoredirectEnabled": { "type": "boolean" }, "rfc": { "type": "object", "properties": { "homoclave": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } } } }, "curp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "income": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "loanAmount": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "steps": { "type": "object", "properties": { "title": { "type": "string" } } }, "general": { "type": "object", "properties": { "termsAndConditions": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } }, "privacyPolicies": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } } } }, "sections": { "type": "object", "properties": { "bureauQueryAuthorization": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "generalInfo": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "start": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "thanks": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "submit": { "type": "string" }, "isImageEnabled": { "type": "boolean" } } } } }, "retryTimeouts": { "type": "object", "properties": { "sms": { "type": "number", "minimum": 35 }, "email": { "type": "number", "minimum": 35 } } }, "tokenDurationDays": { "type": "number", "minimum": 1, "maximum": 30, "nullable": true } } }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "accountType": { "type": "string", "enum": [ "PM" ] }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "caBlacklist": { "type": "boolean" }, "bl-busqueda_judicial": { "additionalProperties": false, "type": "boolean" } } } } }, { "type": "object", "title": "PF", "properties": { "name": { "type": "string" }, "formCompletedURL": { "type": "string", "format": "url", "nullable": true }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "maxLength": 200 }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "nip": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "isActive": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isAutoredirectEnabled": { "type": "boolean" }, "rfc": { "type": "object", "properties": { "homoclave": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } } } }, "curp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "income": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "loanAmount": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "steps": { "type": "object", "properties": { "title": { "type": "string" } } }, "general": { "type": "object", "properties": { "termsAndConditions": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } }, "privacyPolicies": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } } } }, "sections": { "type": "object", "properties": { "bureauQueryAuthorization": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "generalInfo": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "start": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "thanks": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "submit": { "type": "string" }, "isImageEnabled": { "type": "boolean" } } } } }, "retryTimeouts": { "type": "object", "properties": { "sms": { "type": "number", "minimum": 35 }, "email": { "type": "number", "minimum": 35 } } }, "tokenDurationDays": { "type": "number", "minimum": 1, "maximum": 30, "nullable": true } } }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "accountType": { "type": "string", "enum": [ "PF" ] }, "serviceQueries": { "type": "object", "properties": { "bureauPF": { "type": "boolean" }, "bureauPM": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "jumioIdValidation": { "type": "boolean" }, "caBlacklist": { "type": "boolean" }, "circuloCreditoPF": { "type": "boolean" }, "bl-busqueda_judicial": { "additionalProperties": false, "type": "boolean" } } } } } ] }, "examples": { "PM": { "value": { "name": "PM form", "slug": "pm-form", "serviceQueries": { "bureauPM": true, "satBlackList": true, "satRFC": true }, "configuration": { "isActive": true }, "accountType": "PM" } }, "PF": { "value": { "name": "PF form", "slug": "pf-form", "serviceQueries": { "bureauPM": true, "bureauPF": true, "renapoCURP": true }, "configuration": { "isActive": true, "rfc": { "homoclave": { "enabled": true } } }, "accountType": "PF" } } } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string" }, "accountType": { "type": "string" }, "formCompletedURL": { "type": "string", "format": "url", "nullable": true }, "slug": { "type": "string", "pattern": "^[a-zA-Z0-9\\-]*$", "maxLength": 200 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "configuration": { "type": "object", "additionalProperties": false, "properties": { "nip": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "isActive": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isAutoredirectEnabled": { "type": "boolean" }, "rfc": { "type": "object", "properties": { "homoclave": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } } } }, "curp": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "income": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "loanAmount": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "required": { "type": "boolean" } } }, "steps": { "type": "object", "properties": { "title": { "type": "string" } } }, "general": { "type": "object", "properties": { "termsAndConditions": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } }, "privacyPolicies": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": [ "null", "string" ], "format": "url" } } } } }, "sections": { "type": "object", "properties": { "bureauQueryAuthorization": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "generalInfo": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "start": { "type": "object", "properties": { "title": { "type": [ "null", "string" ], "maxLength": 200 }, "description": { "type": [ "null", "string" ], "maxLength": 2000 } } }, "thanks": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "submit": { "type": "string" }, "isImageEnabled": { "type": "boolean" } } } } }, "retryTimeouts": { "type": "object", "properties": { "sms": { "type": "number", "minimum": 35 }, "email": { "type": "number", "minimum": 35 } } }, "tokenDurationDays": { "type": "number", "minimum": 1, "maximum": 30, "nullable": true } } }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "integer" }, "customPagesConfig": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "formConfigId": { "type": "integer" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 1, "maxLength": 256, "type": "string" }, "component": { "minLength": 3, "maxLength": 256, "type": "string", "enum": [ "Select", "TextArea", "TextInput", "Radio", "File", "Checkbox" ] }, "isRequired": { "type": "boolean", "default": false }, "config": { "type": "object", "additionalProperties": true, "description": "The schema of the config depends on the component type" }, "section": { "type": "string" } }, "additionalProperties": false, "allOf": [ { "if": { "type": "object", "properties": { "component": { "enum": [ "Radio" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1 } }, "required": [ "options" ] } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "Select" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1 } }, "required": [ "options" ] } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "TextInput" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "minLength": { "type": "integer", "minimum": 0, "maximum": 1024, "default": 0 }, "maxLength": { "type": "integer", "minimum": 1, "maximum": 1024, "default": 256 }, "matchRegEx": { "type": "string", "format": "regex", "default": null, "nullable": true } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "TextArea" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "minLength": { "type": "integer", "minimum": 0, "maximum": 16384, "default": 0 }, "maxLength": { "type": "integer", "minimum": 1, "maximum": 16384, "default": 256 }, "matchRegEx": { "type": "string", "format": "regex", "default": null, "nullable": true } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "File" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 256 }, "fileCollectionId": { "type": "integer", "default": null, "nullable": true }, "parentFileCollectionId": { "type": "integer", "default": null, "nullable": true }, "fileType": { "type": "string", "enum": [ "jpeg", "png", "pdf", "csv", "json" ] }, "maxSize": { "type": "integer", "default": null, "nullable": true, "maximum": 50000000, "description": "Maximum size of 50MB" } }, "additionalProperties": false } } } }, { "if": { "type": "object", "properties": { "component": { "enum": [ "Checkbox" ] } } }, "then": { "type": "object", "properties": { "config": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "minLength": 1, "maxLength": 256, "type": "string" }, "value": { "minLength": 1, "maxLength": 256, "type": "string" } }, "required": [ "label", "value" ] }, "minItems": 1, "maxItems": 20 }, "maxSelections": { "type": "integer", "default": null, "nullable": true, "minimum": 1, "maximum": 20 }, "minSelections": { "type": "integer", "default": 1, "minimum": 1, "maximum": 20 } }, "required": [ "options" ], "additionalProperties": false } } } } ], "required": [ "label", "slug", "component", "config" ] }, "minItems": 1 }, "pages": { "type": "object", "additionalProperties": false, "properties": { "beforeGeneralInformation": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "descriptionPage": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 3, "maxLength": 256, "type": "string" } } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "minItems": 1, "maxItems": 20 }, "submitButton": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" } } } } } }, "afterGeneralInformation": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "descriptionPage": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" }, "description": { "minLength": 3, "maxLength": 256, "type": "string" } } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "minLength": 3, "maxLength": 256, "type": "string" }, "slug": { "minLength": 3, "maxLength": 256, "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "minItems": 1, "maxItems": 20 }, "submitButton": { "type": "object", "additionalProperties": false, "properties": { "label": { "minLength": 3, "maxLength": 256, "type": "string" } } } } } } } } } }, "serviceQueries": { "type": "object", "additionalProperties": false, "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "jumioIdValidation": { "type": "boolean" }, "circuloCreditoPF": { "type": "boolean" }, "caBlacklist": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } } } } } } } } } }, "/api/v1/forms": { "get": { "tags": [ "forms" ], "description": "Retrieve form submissions", "parameters": [ { "schema": { "type": "number" }, "in": "query", "name": "profileId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeDetailedTags", "required": false }, { "schema": { "type": "integer", "minimum": 10, "maximum": 2000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "DESC", "ASC" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "object", "properties": { "formConfigId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact formConfigId." }, "formConfigId__gt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formConfigId greater than specified value." }, "formConfigId__gte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formConfigId less than specified value." }, "formConfigId__lt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formConfigId less than specified value." }, "formConfigId__lte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formConfigId less than specified value." }, "formConfigId__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified formConfigId." }, "accountType__eq": { "anyOf": [ { "type": "string", "enum": [ "PF", "PM" ] }, { "type": "array", "items": { "type": "string", "enum": [ "PF", "PM" ] } } ], "description": "Filter by exact accountType." }, "accountType__anyOf": { "anyOf": [ { "type": "string", "enum": [ "PF", "PM" ] }, { "type": "array", "items": { "type": "string", "enum": [ "PF", "PM" ] } } ], "description": "Filter by any of the specified accountType." }, "profileId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact profileId." }, "profileId__gt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId greater than specified value." }, "profileId__gte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId less than specified value." }, "profileId__lt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId less than specified value." }, "profileId__lte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId less than specified value." }, "profileId__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified profileId." }, "createdAt__eq": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by exact createdAt." }, "createdAt__gt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt greater than specified value." }, "createdAt__gte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt less than specified value." }, "createdAt__isNull": { "type": "boolean", "description": "Filter by createdAt is null or not." }, "createdAt__lt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt less than specified value." }, "createdAt__lte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt less than specified value." }, "updatedAt__eq": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by exact updatedAt." }, "updatedAt__gt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by updatedAt greater than specified value." }, "updatedAt__gte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by updatedAt less than specified value." }, "updatedAt__isNull": { "type": "boolean", "description": "Filter by updatedAt is null or not." }, "updatedAt__lt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by updatedAt less than specified value." }, "updatedAt__lte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by updatedAt less than specified value." }, "completedDate__eq": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by exact completedDate." }, "completedDate__gt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by completedDate greater than specified value." }, "completedDate__gte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by completedDate less than specified value." }, "completedDate__isNull": { "type": "boolean", "description": "Filter by completedDate is null or not." }, "completedDate__lt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by completedDate less than specified value." }, "completedDate__lte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by completedDate less than specified value." }, "tagIds__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified tagIds." }, "tagIds__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact tagIds." }, "tags__anyOf": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by any of the specified tags." }, "tags__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact tags." }, "searchVector__search": { "type": "string", "description": "Filter using full-text search on specified fields(firstName, middleName, firstLastName, secondLastName, tradeName, CURP, RFC, phone or email)." } } }, "in": "query", "name": "filter", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } } } }, "total": { "type": "number" } } } } } } } } }, "/api/v1/forms/{id}": { "get": { "tags": [ "forms" ], "description": "Retrieve form submission", "parameters": [ { "schema": { "type": "number", "minimum": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nip": { "type": "string" }, "id": { "type": "number" }, "accountType": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "firstLastName": { "type": "string", "nullable": true }, "secondLastName": { "type": "string", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "nullable": true }, "basicRFC": { "type": "string", "nullable": true }, "curp": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "format": "date", "nullable": true }, "address": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "exteriorNumber": { "type": "string", "nullable": true }, "interiorNumber": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "nullable": true }, "country": { "type": "string", "nullable": true }, "municipality": { "type": "string", "nullable": true }, "monthlyIncome": { "type": "number", "nullable": true }, "loanAmount": { "type": "number", "nullable": true }, "extraInformation": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileId": { "type": "number", "nullable": true }, "isNipConfirmed": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "formConfig": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "name": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "serviceQueries": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" } } }, "bureauAuthTradeName": { "type": "string", "nullable": true }, "formCompletedURL": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customPagesConfigId": { "type": "number", "nullable": true } } }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "number" } }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "customPagesConfigId": { "type": "number", "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true, "additionalProperties": true }, "nipSmsSentCount": { "type": "number", "nullable": true }, "nipEmailSentCount": { "type": "number", "nullable": true } } } } } }, "403": { "description": "Forbidden response", "content": { "application/json": { "schema": { "type": "object", "description": "Forbidden response", "properties": { "statusCode": { "type": "number", "enum": [ 403 ] }, "error": { "type": "string", "enum": [ "Forbidden" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } } } } }, "/api/v1/forms/{id}/query": { "post": { "tags": [ "forms" ], "description": "Request form services", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "caBlacklist": { "type": "boolean" }, "circuloCreditoPF": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } } } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": true, "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "statusCode": { "type": "number" }, "message": { "type": "string" } } } } } } } } }, "500": { "description": "Error schema", "content": { "application/json": { "schema": { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } } } } } } } }, "/api/v1/postal-codes/{postalCode}": { "get": { "tags": [ "postal codes" ], "description": "Get neighborhoods by zip code", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d{5}$" }, "in": "path", "name": "postalCode", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "postalCode": { "type": "string", "description": "Codigo postal" }, "neighborhood": { "type": "string", "description": "Asentamiento. Ejemplo: Rinconada del valle" }, "neighborhoodType": { "type": "string", "description": "Tipo de asentamiento. Ejemplo: Colonia, fraccionamiento, etc" }, "municipality": { "type": "string", "description": "Municipio" }, "state": { "type": "string", "description": "Estado" }, "city": { "type": "string", "description": "Ciudad" }, "administrationPostalCode": { "type": "string", "description": "Codigo postal de la administracion postal que reparte al asentamiento" }, "stateCode": { "type": "string", "description": "Codigo del estado" }, "officePostalCode": { "type": "string", "description": "Codigo postal de la administracion postal que reparte al asentamiento" }, "neighborhoodTypeCode": { "type": "string", "description": "Codigo del tipo de asentamiento" }, "municipalityCode": { "type": "string", "description": "Codigo del municipio" }, "neighborhoodId": { "type": "string", "description": "Identificador unico del asentamiento (Nivel municipal)" }, "zone": { "type": "string", "description": "Zona. Ejemplo: Urbano o Rural" }, "cityCode": { "type": "string", "description": "Codigo de la ciudad" } } } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "404": { "description": "Postal code not found", "content": { "application/json": { "schema": { "type": "object", "description": "Postal code not found", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 404 ] }, "description": { "type": "string" } } } } } } } } }, "/api/v1/profiles/{id}": { "put": { "tags": [ "profiles" ], "description": "Edit a profile", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "accountType" ], "anyOf": [ { "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"", "nullable": true } } }, { "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\" ISO timestamps are allowed but the time part is ignored.", "nullable": true } } } ] }, "examples": { "PF": { "value": { "email": "maestela@moffin.mx", "firstName": "MA", "middleName": "ESTELA", "rfc": "AESE500614JK1", "basicRFC": "AESE500614", "firstLastName": "ARENAS", "secondLastName": "SANCHEZ", "address": "ZARAGOZA OTE NO 15-A", "city": "TLAXCALA", "state": "TLA", "zipCode": "90500", "nationality": "MX", "exteriorNumber": "", "interiorNumber": "", "neighborhood": "HUAMANTLA", "municipality": "", "accountType": "PF", "country": "MX" } }, "PM": { "value": { "tradeName": "ALMACENES GHINOS,SA DE CV", "rfc": "AGS930324RN7", "basicRFC": "AGS930324", "address": "AV IGNACIO ALLENDE LOTE 11-B LOCAL 2", "city": "TEPEAPULCO", "state": "HID", "zipCode": "43990", "nationality": "MX", "country": "MX", "neighborhood": "CD SAHAGUN HGO", "accountType": "PM" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ] } } } } } }, "get": { "tags": [ "profiles" ], "description": "Get a profile by ID", "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ] } } } } } } }, "/api/v1/profiles": { "post": { "tags": [ "profiles" ], "description": "Create profile", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "accountType" ], "anyOf": [ { "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"", "nullable": true } } }, { "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\" ISO timestamps are allowed but the time part is ignored.", "nullable": true } } } ] }, "examples": { "PF": { "value": { "email": "maestela@moffin.mx", "firstName": "MA", "middleName": "ESTELA", "rfc": "AESE500614JK1", "basicRFC": "AESE500614", "firstLastName": "ARENAS", "secondLastName": "SANCHEZ", "address": "ZARAGOZA OTE NO 15-A", "city": "TLAXCALA", "state": "TLA", "zipCode": "90500", "nationality": "MX", "exteriorNumber": "", "interiorNumber": "", "neighborhood": "HUAMANTLA", "municipality": "", "accountType": "PF", "country": "MX" } }, "PM": { "value": { "tradeName": "ALMACENES GHINOS,SA DE CV", "rfc": "AGS930324RN7", "basicRFC": "AGS930324", "address": "AV IGNACIO ALLENDE LOTE 11-B LOCAL 2", "city": "TEPEAPULCO", "state": "HID", "zipCode": "43990", "nationality": "MX", "country": "MX", "neighborhood": "CD SAHAGUN HGO", "accountType": "PM" } } } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ] } } } } } }, "get": { "tags": [ "profiles" ], "description": "Get profiles with pagination", "parameters": [ { "schema": { "type": "integer", "minimum": 10, "maximum": 2000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "DESC", "ASC" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "string", "minLength": 12, "maxLength": 13 }, "in": "query", "name": "rfc", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "externalId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeDetailedTags", "required": false }, { "schema": { "type": "object", "properties": { "accountType__eq": { "anyOf": [ { "type": "string", "enum": [ "PF", "PM" ] }, { "type": "array", "items": { "type": "string", "enum": [ "PF", "PM" ] } } ], "description": "Filter by exact accountType." }, "accountType__anyOf": { "anyOf": [ { "type": "string", "enum": [ "PF", "PM" ] }, { "type": "array", "items": { "type": "string", "enum": [ "PF", "PM" ] } } ], "description": "Filter by any of the specified accountType." }, "createdAt__eq": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by exact creation datetime." }, "createdAt__gt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by creation datetime greater than specified value." }, "createdAt__gte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by creation datetime less than specified value." }, "createdAt__isNull": { "type": "boolean", "description": "Filter by creation datetime is null or not." }, "createdAt__lt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by creation datetime less than specified value." }, "createdAt__lte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by creation datetime less than specified value." }, "updatedAt__eq": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by exact update datetime." }, "updatedAt__gt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by update datetime greater than specified value." }, "updatedAt__gte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by update datetime less than specified value." }, "updatedAt__isNull": { "type": "boolean", "description": "Filter by update datetime is null or not." }, "updatedAt__lt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by update datetime less than specified value." }, "updatedAt__lte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by update datetime less than specified value." }, "searchVector__search": { "type": "string", "description": "Filter using full-text search on specified fields(firstName, middleName, firstLastName, secondLastName, tradeName, CURP, RFC, phone or email)." }, "tagIds__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified tagIds." }, "tagIds__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact tagIds." }, "tags__anyOf": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by any of the specified tags." }, "tags__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact tags." }, "rfc__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact rfc." }, "externalId__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact externalId." }, "id__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified id." }, "id__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact id." } } }, "in": "query", "name": "filter", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "profiles": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ] } } } } } } } } } }, "/api/v1/profiles/info": { "post": { "tags": [ "profiles" ], "description": "Create or update many profiles at the same time", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "accountType" ], "anyOf": [ { "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"", "nullable": true } } }, { "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\" ISO timestamps are allowed but the time part is ignored.", "nullable": true } } } ] } }, "examples": { "PF": { "value": [ { "email": "maestela@moffin.mx", "firstName": "MA", "middleName": "ESTELA", "rfc": "AESE500614JK1", "basicRFC": "AESE500614", "firstLastName": "ARENAS", "secondLastName": "SANCHEZ", "address": "ZARAGOZA OTE NO 15-A", "city": "TLAXCALA", "state": "TLA", "zipCode": "90500", "nationality": "MX", "exteriorNumber": "", "interiorNumber": "", "neighborhood": "HUAMANTLA", "municipality": "", "accountType": "PF", "country": "MX" } ] }, "PM": { "value": [ { "tradeName": "ALMACENES GHINOS,SA DE CV", "rfc": "AGS930324RN7", "basicRFC": "AGS930324", "address": "AV IGNACIO ALLENDE LOTE 11-B LOCAL 2", "city": "TEPEAPULCO", "state": "HID", "zipCode": "43990", "nationality": "MX", "country": "MX", "neighborhood": "CD SAHAGUN HGO", "accountType": "PM" } ] } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "default": "MX", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 } }, "required": [ "accountType" ] } } } } } } } } } }, "/api/v1/profiles/{id}/query": { "post": { "tags": [ "profiles" ], "description": "Query profile services", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "bureauPM": { "type": "boolean" }, "bureauPF": { "type": "boolean" }, "satBlackList": { "type": "boolean" }, "satRFC": { "type": "boolean" }, "renapoCurp": { "type": "boolean" }, "prospectorPF": { "type": "boolean" }, "imssJobHistory": { "type": "boolean", "deprecated": true }, "jumioIdValidation": { "type": "boolean" }, "caBlacklist": { "type": "boolean", "description": "BETA (In development)" }, "circuloCreditoPF": { "type": "boolean" }, "bl-busqueda_judicial": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } } } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": true, "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "statusCode": { "type": "number" }, "message": { "type": "string" } } } } } } } } }, "500": { "description": "Error schema", "content": { "application/json": { "schema": { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } } } } } } } }, "/api/v1/profiles/{id}/info": { "get": { "tags": [ "profiles" ], "description": "Get a moffin reduced profile", "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "identity": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "externalId": { "type": "string" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "firstLastName": { "type": "string" }, "secondLastName": { "type": "string" }, "phone": { "type": "string" }, "tradeName": { "type": "string" }, "rfc": { "type": "string" }, "curp": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] } } }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "address2": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ] }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string" }, "interiorNumber": { "type": "string" }, "source": { "type": "string", "enum": [ "MOFFIN", "BURO", "SAT" ] } } } }, "sat": { "type": "object", "properties": { "rfc": { "type": "string" }, "blacklistStatus": { "type": "string", "enum": [ "Desvirtuado", "Presunto", "Sentencia favorable", "Definitivo" ] }, "isValid": { "type": "boolean" }, "certificates": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "serialNumber": { "type": "string" }, "name": { "type": "string", "description": "Razon social" }, "email": { "type": "string", "format": "email" }, "curp": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "legalRepresentative": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "serialNumber": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "curp": { "type": "string" }, "rfc": { "type": "string" }, "path": { "type": "string" }, "isActive": { "type": "boolean" } } } } } } } }, "renapo": { "type": "object", "properties": { "curp": { "type": "string" }, "firstName": { "type": "string" }, "firstLastName": { "type": "string" }, "secondLastName": { "type": "string" }, "sex": { "type": "string" }, "birthdate": { "type": "string" }, "birthCountry": { "type": "string" }, "birthState": { "type": "string" }, "document": { "type": "string" } } } } } } } } } } }, "/api/v1/query/prospector_pf": { "post": { "tags": [ "Query data sources" ], "description": "Bureau \"persona fisica\" score", "requestBody": { "content": { "application/json": { "schema": { "title": "Persona Física", "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "phone": { "type": "string", "description": "If the number it's not mexican is omitted in the service, but saved in profile." }, "rfc": { "type": "string", "RFCValidator": { "rfcType": "PF", "homoclave": { "enabled": true, "required": false } } }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "maxLength": 18, "minLength": 18 }, "accountType": { "type": "string", "enum": [ "PF" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "differenceInYears": { "op": "gt", "value": "10" } }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } }, "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "additionalProperties": false, "required": [ "rfc", "firstName", "firstLastName", "address", "zipCode", "state", "country", "nationality", "neighborhood", "birthdate", "municipality", "city" ], "example": { "birthdate": "1980-01-01", "email": "test-dev@moffin.mx", "firstName": "UNO", "firstLastName": "PRUEBA", "secondLastName": "PROSPECTOR", "rfc": "PRPU800101HM2", "accountType": "PF", "address": "Jaime Balmes", "city": "Cd de Mexico", "municipality": "Miguel Hidalgo", "state": "CMX", "zipCode": "11510", "exteriorNumber": "8", "neighborhood": "Los morales", "country": "MX", "nationality": "MX" } }, "example": { "birthdate": "1980-01-01", "email": "test-dev@moffin.mx", "firstName": "UNO", "firstLastName": "PRUEBA", "secondLastName": "PROSPECTOR", "rfc": "PRPU800101HM2", "accountType": "PF", "address": "Jaime Balmes", "city": "Cd de Mexico", "municipality": "Miguel Hidalgo", "state": "CMX", "zipCode": "11510", "exteriorNumber": "8", "neighborhood": "Los morales", "country": "MX", "nationality": "MX" } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of Bureau \"persona fisica\" score", "nullable": true, "additionalProperties": false, "properties": { "intlQuery": { "type": "string" }, "intl": { "type": "string" }, "json": { "type": "object", "properties": { "reference": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" } } } }, "name": { "type": "object", "properties": { "firstname": { "type": "string" }, "middlename": { "type": "string" }, "firstLastname": { "type": "string" }, "secondLastname": { "type": "string" }, "extraLastname": { "type": "string" }, "birthdate": { "type": "string" }, "rfc": { "type": "string" }, "nationality": { "type": "string", "enum": [ "MX" ] }, "residenceType": { "type": "string", "enum": [ "1", "2", "3" ] }, "maritalStatus": { "type": "string", "enum": [ "D", "F", "M", "S", "W" ] }, "sex": { "type": "string", "enum": [ "F", "M" ] }, "curp": { "type": "string" }, "economicDependents": { "type": "string" } } }, "address": { "type": "object", "properties": { "address": { "type": "string" }, "address2": { "type": "string" }, "neighborhood": { "type": "string" }, "municipality": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "phone": { "type": "string" }, "addressType": { "type": "string", "enum": [ "B", "C", "H", "P" ] }, "specialAddressType": { "type": "string", "enum": [ "M", "R", "K" ] } } }, "score": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "value": { "type": "string" }, "cause1": { "type": "string" }, "cause2": { "type": "string" }, "cause3": { "type": "string" }, "errorCode": { "type": "string" } } }, "header": { "type": "object", "properties": { "segmentTag": { "type": "string", "enum": [ "INTL", "ERRR" ] }, "version": { "type": "string", "enum": [ "11", "12" ] }, "reference": { "type": "string" }, "countryCode": { "type": "string", "enum": [ "MX" ] }, "reservedUse1": { "type": "string" }, "userKey": { "type": "string" }, "wasFound": { "type": "string", "enum": [ "1", "0" ] }, "reservedUse2": { "type": "string" } } }, "fileEnd": { "type": "object", "properties": { "fileLength": { "type": "string" }, "controlNumber": { "type": "string" }, "endMark": { "type": "string" } } }, "userError": { "type": "object", "properties": { "reference": { "type": "string" }, "requestError": { "type": "string", "description": "solicitud del cliente erronea" }, "versionError": { "type": "string", "description": "versión proporcionada erronea" }, "productKeyError": { "type": "string", "description": "producto solicitado erroneo" }, "userKeyPasswordError": { "type": "string", "description": "clave de usuario o contraseña erronea" }, "noRequiredSegmentError": { "type": "string", "description": "segmento requerido no proporcionado" }, "latestValidInformation": { "type": "string", "description": "última información valida cliente" }, "informationError": { "type": "string", "description": "información erronea para la consulta" }, "relatedValuesError": { "type": "string", "description": "valor erroneo en un campo relacionado" }, "bureauSystemError": { "type": "string" }, "segmentTagError": { "type": "string" }, "segmentOrderError": { "type": "string" }, "segmentNumberError": { "type": "string" }, "missedRequiredFieldError": { "type": "string" }, "lockedRecordError": { "type": "string" } } }, "authError": { "type": "object", "properties": { "reference": { "type": "string" }, "personNotAuthenticated": { "type": "string" }, "userKeyPasswordError": { "type": "string" }, "bureauSystemError": { "type": "string" }, "segmentTagError": { "type": "string" }, "missedRequiredFieldError": { "type": "string" }, "lockedFile": { "type": "string" } } } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "example": { "id": 1, "authentication": "CUSTOM", "service": "prospector_pf", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PF", "reportType": "prospector_pf", "query": { "rfc": "CARA2210175B8", "city": "Cd de Mexico", "curp": "", "email": "example@example.com", "phone": "", "state": "CMX", "address": "Jaime Balmes", "country": "MX", "zipCode": "11510", "birthdate": "2001-10-18T06:00:00.000Z", "firstName": "UNO", "externalId": "", "middleName": "", "accountType": "PF", "nationality": "MX", "municipality": "Miguel Hidalgo", "neighborhood": "Los morales", "firstLastName": "PRUEBA", "secondLastName": "PROSPECTOR" } }, "query": { "header": { "version": "12", "reference": "881b06bf-efa3-4b3c-9e8b-a", "countryCode": "MX", "userKey": "ZM4*******", "password": "********", "productKey": "107", "language": "SP", "responsibilityType": "I", "productType": "CC", "currencyCode": "MX", "loanAmount": "000000000", "outputType": "01", "responseBlockSize": " " }, "name": { "firstname": "UNO", "firstLastname": "PRUEBA", "secondLastname": "PROSPECTOR", "birthdate": "18102001", "rfc": "CARA2210175B8", "countryKey": "MX", "nationality": "MX" }, "address": { "address": "JAIME BALMES 8", "municipality": "MIGUEL HIDALGO", "city": "CD DE MEXICO", "neighborhood": "LOS MORALES", "state": "CDMX", "zipCode": "11510", "addressCountry": "MX" } }, "response": { "intlQuery": "INTL12881b06bf-efa3-4b3c-9e8b-a107MX0000ZM4***************ICCMX000000000SP01 0000000PN06PRUEBA0010PROSPECTOR0203UNO0408181020010513CARA2210175B80802MX1602MXPA14JAIME BALMES 80111LOS MORALES0214MIGUEL HIDALGO0312CD DE MEXICO0404CDMX0505115101302MXES05002650002**", "intl": "INTL12881b06bf-efa3-4b3c-9e8b-aMX0000ZM4*******10PN06PRUEBA0010PROSPECTOR0203UNO0408181020010513CARA2210175B80802MX1602MXPA14JAIME BALMES 80111LOS MORALES0214MIGUEL HIDALGO0312CD DE MEXICO0404CDMX0505115101302MXSC08BC SCORE000300701040707020204030209ES0500279001020179170430102**\u0013", "json": { "reference": "881b06bf-efa3-4b3c-9e8b-a", "name": { "firstname": "UNO", "firstLastname": "PRUEBA", "secondLastname": "PROSPECTOR", "birthdate": "18102001", "rfc": "CARA2210175B8", "nationality": "MX" }, "address": { "address": "JAIME BALMES 8", "neighborhood": "LOS MORALES", "municipality": "MIGUEL HIDALGO", "city": "CD DE MEXICO", "state": "CDMX", "zipCode": "11510" }, "score": { "name": "BC SCORE", "code": "007", "value": "0707", "cause1": "04", "cause2": "09" }, "header": { "segmentTag": "INTL", "version": "12", "reference": "881b06bf-efa3-4b3c-9e8b-a", "countryCode": "MX", "reservedUse1": "0000", "userKey": "ZM44441180", "wasFound": "1", "reservedUse2": "0" }, "fileEnd": { "fileLength": "00279", "endMark": "**" } } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T16:56:25.435Z", "updatedAt": "2023-07-05T16:56:28.201Z", "deletedAt": null, "cachedFrom": null } }, "example": { "id": 1, "authentication": "CUSTOM", "service": "prospector_pf", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PF", "reportType": "prospector_pf", "query": { "rfc": "CARA2210175B8", "city": "Cd de Mexico", "curp": "", "email": "example@example.com", "phone": "", "state": "CMX", "address": "Jaime Balmes", "country": "MX", "zipCode": "11510", "birthdate": "2001-10-18T06:00:00.000Z", "firstName": "UNO", "externalId": "", "middleName": "", "accountType": "PF", "nationality": "MX", "municipality": "Miguel Hidalgo", "neighborhood": "Los morales", "firstLastName": "PRUEBA", "secondLastName": "PROSPECTOR" } }, "query": { "header": { "version": "12", "reference": "881b06bf-efa3-4b3c-9e8b-a", "countryCode": "MX", "userKey": "ZM4*******", "password": "********", "productKey": "107", "language": "SP", "responsibilityType": "I", "productType": "CC", "currencyCode": "MX", "loanAmount": "000000000", "outputType": "01", "responseBlockSize": " " }, "name": { "firstname": "UNO", "firstLastname": "PRUEBA", "secondLastname": "PROSPECTOR", "birthdate": "18102001", "rfc": "CARA2210175B8", "countryKey": "MX", "nationality": "MX" }, "address": { "address": "JAIME BALMES 8", "municipality": "MIGUEL HIDALGO", "city": "CD DE MEXICO", "neighborhood": "LOS MORALES", "state": "CDMX", "zipCode": "11510", "addressCountry": "MX" } }, "response": { "intlQuery": "INTL12881b06bf-efa3-4b3c-9e8b-a107MX0000ZM4***************ICCMX000000000SP01 0000000PN06PRUEBA0010PROSPECTOR0203UNO0408181020010513CARA2210175B80802MX1602MXPA14JAIME BALMES 80111LOS MORALES0214MIGUEL HIDALGO0312CD DE MEXICO0404CDMX0505115101302MXES05002650002**", "intl": "INTL12881b06bf-efa3-4b3c-9e8b-aMX0000ZM4*******10PN06PRUEBA0010PROSPECTOR0203UNO0408181020010513CARA2210175B80802MX1602MXPA14JAIME BALMES 80111LOS MORALES0214MIGUEL HIDALGO0312CD DE MEXICO0404CDMX0505115101302MXSC08BC SCORE000300701040707020204030209ES0500279001020179170430102**\u0013", "json": { "reference": "881b06bf-efa3-4b3c-9e8b-a", "name": { "firstname": "UNO", "firstLastname": "PRUEBA", "secondLastname": "PROSPECTOR", "birthdate": "18102001", "rfc": "CARA2210175B8", "nationality": "MX" }, "address": { "address": "JAIME BALMES 8", "neighborhood": "LOS MORALES", "municipality": "MIGUEL HIDALGO", "city": "CD DE MEXICO", "state": "CDMX", "zipCode": "11510" }, "score": { "name": "BC SCORE", "code": "007", "value": "0707", "cause1": "04", "cause2": "09" }, "header": { "segmentTag": "INTL", "version": "12", "reference": "881b06bf-efa3-4b3c-9e8b-a", "countryCode": "MX", "reservedUse1": "0000", "userKey": "ZM44441180", "wasFound": "1", "reservedUse2": "0" }, "fileEnd": { "fileLength": "00279", "endMark": "**" } } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T16:56:25.435Z", "updatedAt": "2023-07-05T16:56:28.201Z", "deletedAt": null, "cachedFrom": null } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } }, { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": true, "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } ] } } } } } } }, "/api/v1/query/bureau_pf": { "post": { "tags": [ "Query data sources" ], "description": "Bureau \"persona fisica\" report", "requestBody": { "content": { "application/json": { "schema": { "title": "Persona Fisica", "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "phone": { "type": "string", "PhoneValidator": { "allowNull": false } }, "rfc": { "RFCValidator": { "rfcType": "PF", "homoclave": { "enabled": true, "required": false } } }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "maxLength": 18, "minLength": 18 }, "accountType": { "type": "string", "enum": [ "PF" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "differenceInYears": { "op": "gt", "value": "10" } }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } }, "productType": { "type": "string", "enum": [ "207", "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "520", "521", "540", "541", "542", "545", "546", "547", "548", "553", "554", "557", "558", "559", "560", "567", "568", "575", "577", "580", "581", "001", "004", "006", "007", "009", "010", "011", "013", "016", "017", "020", "040", "041", "042", "045", "046", "047", "048", "053", "054", "057", "058", "059", "060", "067", "068", "075", "077", "080", "081" ], "description": "Bureau credit type" }, "creditType": { "type": "string", "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ], "description": "Bureau product type" }, "user": { "type": "string", "maxLength": 256, "description": "\"Credit bureau\" user key" }, "password": { "type": "string", "maxLength": 256, "description": "\"Credit bureau\" password credential" }, "creditReference": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "maxLength": 25, "minLength": 1 }, "lenderCode": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true }, "lenderName": { "type": "string", "maxLength": 16, "minLength": 1, "nullable": true } }, "required": [ "accountNumber" ] }, "maxItems": 4, "minItems": 1, "description": "Referencia Crediticia (BETA)", "nullable": true } }, "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "additionalProperties": false, "required": [ "rfc", "firstName", "firstLastName", "secondLastName", "address", "zipCode", "state", "country", "nationality", "neighborhood", "birthdate", "municipality", "city" ], "example": { "birthdate": "1950-01-12", "firstName": "DIMITRI", "middleName": "ARNULFO", "firstLastName": "ADAMS", "secondLastName": "ARETIA", "accountType": "PF", "rfc": "BEAS50121757A", "address": "PRL BQUES REFORMA114 EDI 2 A DEP701", "municipality": "CUAJIMALPA DE MORELOS", "neighborhood": "BQUES DE LAS LOMAS", "zipCode": "05120", "state": "CMX", "city": "Ciudad de Mexico", "country": "MX", "exteriorNumber": "114", "nationality": "MX" } }, "example": { "birthdate": "1950-01-12", "firstName": "DIMITRI", "middleName": "ARNULFO", "firstLastName": "ADAMS", "secondLastName": "ARETIA", "accountType": "PF", "rfc": "BEAS50121757A", "address": "PRL BQUES REFORMA114 EDI 2 A DEP701", "municipality": "CUAJIMALPA DE MORELOS", "neighborhood": "BQUES DE LAS LOMAS", "zipCode": "05120", "state": "CMX", "city": "Ciudad de Mexico", "country": "MX", "exteriorNumber": "114", "nationality": "MX" } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of Bureau \"persona fisica\" report", "nullable": true, "additionalProperties": false, "properties": { "return": { "type": "object", "properties": { "Personas": { "type": "object", "properties": { "Persona": { "anyOf": [ { "type": "object", "properties": { "Encabezado": { "type": "object", "properties": { "Version": { "type": "string", "maxLength": 2, "enum": [ "11", "12", "13" ] }, "NumeroReferenciaOperador": { "type": "string", "maxLength": 25 }, "ClavePais": { "type": "string", "maxLength": 2 }, "IdentificadorBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "ClaveRetornoConsumidorPrincipal": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "ClaveRetornoConsumidorSecundario": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "NumeroControlConsulta": { "type": "string", "maxLength": 99 } } }, "Nombre": { "type": "object", "properties": { "ApellidoPaterno": { "type": "string", "maxLength": 26 }, "ApellidoMaterno": { "type": "string", "maxLength": 26 }, "ApellidoAdicional": { "type": "string", "maxLength": 26 }, "PrimerNombre": { "type": "string", "maxLength": 26 }, "SegundoNombre": { "type": "string", "maxLength": 26 }, "FechaNacimiento": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RFC": { "type": "string", "maxLength": 13 }, "Prefijo": { "type": "string", "maxLength": 4, "description": "Se refiere a valores tales como: Sr, Sra, Srta, Lic, Dr, etc" }, "Sufijo": { "type": "string", "maxLength": 4, "enum": [ "JR", "II", "III" ], "description": "JR (Junior), II (Segundo) y III (Tercero)" }, "Nacionalidad": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "Residencia": { "type": "string", "maxLength": 1, "enum": [ "1", "2", "3" ], "description": "1 (Propietario), 2 (Renta) y 3 (Pensión / Vive con familiares)" }, "NumeroLicenciaConducir": { "type": "string", "maxLength": 20 }, "EstadoCivil": { "type": "string", "maxLength": 1, "enum": [ "D", "F", "M", "S", "W" ], "description": "D (Divorciado), F (Unión Libre), M (Casado), S (Soltero) y W (Viudo)" }, "Sexo": { "type": "string", "maxLength": 1, "enum": [ "F", "M" ], "description": "F (Femenino) y M (Masculino)" }, "NumeroCedulaProfesional": { "type": "string", "maxLength": 20 }, "NumeroRegistroElectoral": { "type": "string", "maxLength": 20 }, "ClaveImpuestosOtroPais": { "type": "string", "maxLength": 20 }, "ClaveOtroPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "NumeroDependientes": { "type": "string", "maxLength": 2 }, "EdadesDependientes": { "type": "string", "maxLength": 30, "description": "Se ingresan usando 2 caracteres para cada edad, se permiten hasta 15 consecutivas" }, "FechaRecepcionInformacionDependientes": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaDefuncion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, "Domicilios": { "type": "object", "properties": { "Domicilio": { "anyOf": [ { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Empleos": { "type": "object", "properties": { "Empleo": { "anyOf": [ { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Cuentas": { "type": "object", "properties": { "Cuenta": { "anyOf": [ { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } } }, {} ] } } }, "ConsultasEfectuadas": { "type": "object", "properties": { "ConsultaEfectuada": { "anyOf": [ { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } } }, {} ] } } }, "ResumenReporte": { "type": "object", "properties": { "ResumenReporte": { "anyOf": [ { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } } }, {} ] } } }, "HawkAlertConsulta": { "type": "object", "properties": { "HawkAlertC": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "HawkAlertBD": { "type": "object", "properties": { "HawkAlertBD": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "DeclaracionesCliente": { "type": "object", "properties": { "DeclaracionConsumidor": { "anyOf": [ { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } }, { "type": "array", "items": { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } } }, {} ] } } }, "ScoreBuroCredito": { "type": "object", "properties": { "ScoreBC": { "anyOf": [ { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } }, { "type": "array", "items": { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } } }, {} ] } } }, "CuentaC": { "type": "array", "items": { "type": "object", "properties": { "NumeroCuenta": { "type": "string", "maxLength": 26 }, "ClaveOtorgante": { "type": "string", "maxLength": 10, "nullable": true }, "NombreOtorgante": { "type": "string", "maxLength": 16, "nullable": true } } } } } }, { "type": "array", "items": { "type": "object", "properties": { "Encabezado": { "type": "object", "properties": { "Version": { "type": "string", "maxLength": 2, "enum": [ "11", "12", "13" ] }, "NumeroReferenciaOperador": { "type": "string", "maxLength": 25 }, "ClavePais": { "type": "string", "maxLength": 2 }, "IdentificadorBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "ClaveRetornoConsumidorPrincipal": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "ClaveRetornoConsumidorSecundario": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "NumeroControlConsulta": { "type": "string", "maxLength": 99 } } }, "Nombre": { "type": "object", "properties": { "ApellidoPaterno": { "type": "string", "maxLength": 26 }, "ApellidoMaterno": { "type": "string", "maxLength": 26 }, "ApellidoAdicional": { "type": "string", "maxLength": 26 }, "PrimerNombre": { "type": "string", "maxLength": 26 }, "SegundoNombre": { "type": "string", "maxLength": 26 }, "FechaNacimiento": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RFC": { "type": "string", "maxLength": 13 }, "Prefijo": { "type": "string", "maxLength": 4, "description": "Se refiere a valores tales como: Sr, Sra, Srta, Lic, Dr, etc" }, "Sufijo": { "type": "string", "maxLength": 4, "enum": [ "JR", "II", "III" ], "description": "JR (Junior), II (Segundo) y III (Tercero)" }, "Nacionalidad": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "Residencia": { "type": "string", "maxLength": 1, "enum": [ "1", "2", "3" ], "description": "1 (Propietario), 2 (Renta) y 3 (Pensión / Vive con familiares)" }, "NumeroLicenciaConducir": { "type": "string", "maxLength": 20 }, "EstadoCivil": { "type": "string", "maxLength": 1, "enum": [ "D", "F", "M", "S", "W" ], "description": "D (Divorciado), F (Unión Libre), M (Casado), S (Soltero) y W (Viudo)" }, "Sexo": { "type": "string", "maxLength": 1, "enum": [ "F", "M" ], "description": "F (Femenino) y M (Masculino)" }, "NumeroCedulaProfesional": { "type": "string", "maxLength": 20 }, "NumeroRegistroElectoral": { "type": "string", "maxLength": 20 }, "ClaveImpuestosOtroPais": { "type": "string", "maxLength": 20 }, "ClaveOtroPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "NumeroDependientes": { "type": "string", "maxLength": 2 }, "EdadesDependientes": { "type": "string", "maxLength": 30, "description": "Se ingresan usando 2 caracteres para cada edad, se permiten hasta 15 consecutivas" }, "FechaRecepcionInformacionDependientes": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaDefuncion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, "Domicilios": { "type": "object", "properties": { "Domicilio": { "anyOf": [ { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Empleos": { "type": "object", "properties": { "Empleo": { "anyOf": [ { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Cuentas": { "type": "object", "properties": { "Cuenta": { "anyOf": [ { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } } }, {} ] } } }, "ConsultasEfectuadas": { "type": "object", "properties": { "ConsultaEfectuada": { "anyOf": [ { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } } }, {} ] } } }, "ResumenReporte": { "type": "object", "properties": { "ResumenReporte": { "anyOf": [ { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } } }, {} ] } } }, "HawkAlertConsulta": { "type": "object", "properties": { "HawkAlertC": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "HawkAlertBD": { "type": "object", "properties": { "HawkAlertBD": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "DeclaracionesCliente": { "type": "object", "properties": { "DeclaracionConsumidor": { "anyOf": [ { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } }, { "type": "array", "items": { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } } }, {} ] } } }, "ScoreBuroCredito": { "type": "object", "properties": { "ScoreBC": { "anyOf": [ { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } }, { "type": "array", "items": { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } } }, {} ] } } }, "CuentaC": { "type": "array", "items": { "type": "object", "properties": { "NumeroCuenta": { "type": "string", "maxLength": 26 }, "ClaveOtorgante": { "type": "string", "maxLength": 10, "nullable": true }, "NombreOtorgante": { "type": "string", "maxLength": 16, "nullable": true } } } } } } }, {} ] } } } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "429": { "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "content": { "application/json": { "schema": { "type": "object", "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "properties": { "id": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 429 ] }, "error": { "type": "string", "enum": [ "Too Many Requests" ] }, "message": { "type": "string", "enum": [ "Has excedido el limite de uso de cuenta de moffin. Escribe a soporte de moffin." ] } }, "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } }, { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": true, "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } ] } } } } } } }, "/api/v1/query/bureau_pm": { "post": { "tags": [ "Query data sources" ], "description": "Bureau \"persona moral\" report", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "title": "Persona Moral", "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "phone": { "type": "string", "PhoneValidator": { "allowNull": false } }, "rfc": { "RFCValidator": { "rfcType": "PM", "homoclave": { "enabled": true, "required": false } } }, "accountType": { "type": "string", "enum": [ "PM" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } }, "productType": { "type": "string", "enum": [ "RCE", "RCO", "CALIFICA", "MI_BURO", "INFORME_BURO", "MONITOR", "REPORTE_ACC_AV" ] }, "creditType": { "type": "string", "enum": [ "1300", "1301", "1302", "1303", "1304", "1305", "1306", "1307", "1308", "1309", "1310", "1311", "1314", "1316", "1317", "1320", "1321", "1322", "1323", "1324", "1327", "1340", "1341", "1342", "1350", "1380", "2303", "3011", "3012", "3230", "3231", "6103", "6105", "6228", "6229", "6230", "6240", "6250", "6260", "6270", "6280", "6290", "6291", "6292" ] }, "user": { "type": "string", "maxLength": 256, "description": "\"Credit bureau\" user key" }, "password": { "type": "string", "maxLength": 256, "description": "\"Credit bureau\" password credential" }, "creditReference": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "maxLength": 25, "minLength": 1 } }, "required": [ "accountNumber" ] }, "maxItems": 4, "minItems": 1, "description": "Referencia Crediticia (BETA)", "nullable": true }, "version": { "type": "integer", "enum": [ 4, 5, 6 ] } }, "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "additionalProperties": false, "required": [ "accountType", "tradeName", "rfc", "address", "zipCode", "state", "country", "nationality", "neighborhood", "municipality", "city" ] }, { "title": "Persona Física con Actividad Empresarial", "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "phone": { "type": "string", "PhoneValidator": { "allowNull": false } }, "rfc": { "type": "string", "RFCValidator": { "rfcType": "PF", "homoclave": { "enabled": true, "required": false } } }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "maxLength": 18, "minLength": 18 }, "accountType": { "type": "string", "enum": [ "PF" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "differenceInYears": { "op": "gt", "value": "10" } }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } }, "productType": { "type": "string", "enum": [ "RCE", "RCO", "CALIFICA", "MI_BURO", "INFORME_BURO", "MONITOR", "REPORTE_ACC_AV" ] }, "creditType": { "type": "string", "enum": [ "1300", "1301", "1302", "1303", "1304", "1305", "1306", "1307", "1308", "1309", "1310", "1311", "1314", "1316", "1317", "1320", "1321", "1322", "1323", "1324", "1327", "1340", "1341", "1342", "1350", "1380", "2303", "3011", "3012", "3230", "3231", "6103", "6105", "6228", "6229", "6230", "6240", "6250", "6260", "6270", "6280", "6290", "6291", "6292" ] }, "user": { "type": "string", "maxLength": 256, "description": "\"Credit bureau\" user key" }, "password": { "type": "string", "maxLength": 256, "description": "\"Credit bureau\" password credential" }, "creditReference": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "maxLength": 25, "minLength": 1 } }, "required": [ "accountNumber" ] }, "maxItems": 4, "minItems": 1, "description": "Referencia Crediticia (BETA)", "nullable": true }, "version": { "type": "integer", "enum": [ 4, 5, 6 ] } }, "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "additionalProperties": false, "required": [ "accountType", "rfc", "firstName", "firstLastName", "secondLastName", "address", "zipCode", "state", "country", "nationality", "neighborhood", "birthdate", "municipality" ] } ] }, "examples": { "Persona moral": { "value": { "productType": "INFORME_BURO", "accountType": "PM", "email": "test+almacenes-ghinos@moffin.mx", "tradeName": "ALMACENES GHINOS,SA DE CV", "rfc": "AGS930324RN7", "address": "AV IGNACIO ALLENDE LOTE 11-B LOCAL 2", "city": "TEPEAPULCO", "state": "HID", "zipCode": "43990", "exteriorNumber": "62900", "interiorNumber": "", "neighborhood": "CD SAHAGUN HGO", "municipality": "TEPEAPULCO", "nationality": "MX", "country": "MX" } }, "Persona fisica con actividad empresarial": { "value": { "accountType": "PF", "productType": "INFORME_BURO", "email": "test-dev@moffin.mx", "firstName": "UNO", "firstLastName": "PRUEBA", "secondLastName": "PROSPECTOR", "rfc": "DIMM021113HM2", "address": "Jaime Balmes", "city": "Cd de Mexico", "municipality": "Cd de Mexico", "state": "CMX", "zipCode": "11510", "exteriorNumber": "8", "neighborhood": "Los morales", "country": "MX", "birthdate": "2000-04-17", "nationality": "MX" } } } } } }, "responses": { "201": { "description": "Created response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Success response of bureau PM service", "additionalProperties": false, "properties": { "respuesta": { "type": "object", "additionalProperties": false, "properties": { "encabezado": { "type": "object", "title": "encabezado", "additionalProperties": false, "properties": { "identificadorConsulta": { "type": "string" }, "claveRetorno": { "type": "string" }, "identificadorTransaccion": { "type": "string" }, "fechaConsulta": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } }, "datosGenerales": { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "tipoCliente": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "description": "1 - Persona moral. 2 - Persona física con actividad empresarial. 3 - Fondo o fideicomiso. 4 - Gobierno. 5 - Persona moral PyME" }, "rfcCliente": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombre": { "type": "string", "description": "Presenta la razón social de la empresa o el nombre completo del Cliente consultado.", "maxLength": 75 }, "segundoNombre": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "nacionalidad": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "calificacionCartera": { "type": "string", "maxLength": 56 }, "actividadEconomica1": { "type": "string", "maxLength": 11 }, "actividadEconomica2": { "type": "string", "maxLength": 11 }, "actividadEconomica3": { "type": "string", "maxLength": 11 }, "consultaEntidadFinancieraUltimos3Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraUltimos12Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraUltimos24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraMas24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos3Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos12Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialMas24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "indicadorInformacionAdicional": { "type": "string", "maxLength": 4, "description": "Los posibles valores son PR (Personas relacionadas) y OD (Otras direcciones)." }, "prevenciones": { "type": "string", "maxLength": 64 }, "prevencionesPersona": { "type": "string", "maxLength": 64 }, "prevencionesImpug": { "type": "string", "maxLength": 64 }, "prevencionesPersonalImpug": { "type": "string", "maxLength": 64 } } }, "hawkHr": { "anyOf": [ { "type": "object", "title": "hawkHr", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "title": "hawkHr", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "type": "string", "maxLength": 48 } } } }, {} ] }, "hawkHc": { "anyOf": [ { "type": "object", "title": "hawkHc", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "title": "hawkHc", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "maxLength": 48 } } } }, {} ] }, "declarativa": { "type": "object", "title": "declarativa", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "declarativa1": { "type": "string", "maxLength": 99 }, "declarativa2": { "type": "string", "maxLength": 99 }, "declarativa3": { "type": "string", "maxLength": 99 }, "declarativa4": { "type": "string", "maxLength": 99 }, "declarativa5": { "type": "string", "maxLength": 99 }, "declarativa6": { "type": "string", "maxLength": 99 }, "declarativa7": { "type": "string", "maxLength": 99 }, "declarativa8": { "type": "string", "maxLength": 99 }, "declarativa9": { "type": "string", "maxLength": 99 }, "declarativa10": { "type": "string", "maxLength": 99 }, "declarativa11": { "type": "string", "maxLength": 99 }, "declarativa12": { "type": "string", "maxLength": 99 }, "declarativa13": { "type": "string", "maxLength": 99 }, "declarativa14": { "type": "string", "maxLength": 99 }, "declarativa15": { "type": "string", "maxLength": 99 }, "declarativa16": { "type": "string", "maxLength": 99 }, "declarativa17": { "type": "string", "maxLength": 99 }, "declarativa18": { "type": "string", "maxLength": 99 }, "declarativa19": { "type": "string", "maxLength": 99 }, "declarativa20": { "type": "string", "maxLength": 99 }, "declarativa21": { "type": "string", "maxLength": 99 }, "fechaDeclarativa": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoDeclarativa": { "type": "string", "maxLength": 3 }, "tipoOtorgante": { "type": "string", "maxLength": 3 }, "numeroContrato": { "type": "string", "maxLength": 25 }, "tipoCredito": { "type": "string", "maxLength": 4 } } }, "accionista": { "anyOf": [ { "type": "object", "title": "accionista", "additionalProperties": false, "properties": { "tipoPersona": { "type": "string", "enum": [ "1", "2" ], "description": "1 (Accionista) y 2 (Avalista de)" }, "rfc": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombreAccionista": { "type": "string", "maxLength": 75 }, "segundoNombre": { "type": "string", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "porcentaje": { "type": "string", "maxLength": 2 }, "cantidadAvalada": { "type": "string", "maxLength": 21 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 99 }, "fechaRegistroAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaRegistroAvalista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaAperturaCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } }, { "type": "array", "items": { "type": "object", "title": "accionista", "additionalProperties": false, "properties": { "tipoPersona": { "type": "string", "enum": [ "1", "2" ], "description": "1 (Accionista) y 2 (Avalista de)" }, "rfc": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombreAccionista": { "type": "string", "maxLength": 75 }, "segundoNombre": { "type": "string", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "porcentaje": { "type": "string", "maxLength": 2 }, "cantidadAvalada": { "type": "string", "maxLength": 21 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 99 }, "fechaRegistroAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaRegistroAvalista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaAperturaCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } } }, {} ] }, "creditoFinanciero": { "anyOf": [ { "type": "object", "title": "creditoFinanciero", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "numeroCuenta": { "type": "string", "maxLength": 25 }, "tipoUsuario": { "type": "string", "maxLength": 99 }, "saldoInicial": { "type": "string", "maxLength": 20 }, "moneda": { "type": "string", "maxLength": 3 }, "apertura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "plazo": { "type": "string", "maxLength": 5 }, "tipoCambio": { "type": "string", "maxLength": 21 }, "claveObservacion": { "type": "string", "maxLength": 4 }, "tipoCredito": { "type": "string", "maxLength": 4 }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 21 }, "ultimoPeriodoActualizado": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "fechaCierre": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "pagoCierre": { "type": "string", "maxLength": 21 }, "quita": { "type": "string", "maxLength": 21 }, "dacion": { "type": "string", "maxLength": 21 }, "quebranto": { "type": "string", "maxLength": 21 }, "historicoPagos": { "type": "string", "maxLength": 24 }, "atrasoMayor": { "type": "string", "maxLength": 3 }, "registroImpugnado": { "type": "string", "maxLength": 2 }, "historiaDias": { "type": "string", "maxLength": 36 }, "numeroPagos": { "type": "string", "maxLength": 4 }, "frecuenciaPagos": { "type": "string", "maxLength": 5 }, "montoPago": { "type": "string", "maxLength": 20 }, "fechaUltimoPago": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaReestructura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaPrimerIncumplimiento": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "saldoInsoluto": { "type": "string", "maxLength": 20 }, "creditoMaximoUtilizado": { "type": "string", "maxLength": 20 }, "fechaIngresoCarteraVencida": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoResponsabilidad": { "type": "string", "maxLength": 3 } } }, { "type": "array", "items": { "type": "object", "title": "creditoFinanciero", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "numeroCuenta": { "type": "string", "maxLength": 25 }, "tipoUsuario": { "type": "string", "maxLength": 99 }, "saldoInicial": { "type": "string", "maxLength": 20 }, "moneda": { "type": "string", "maxLength": 3 }, "apertura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "plazo": { "type": "string", "maxLength": 5 }, "tipoCambio": { "type": "string", "maxLength": 21 }, "claveObservacion": { "type": "string", "maxLength": 4 }, "tipoCredito": { "type": "string", "maxLength": 4 }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 21 }, "ultimoPeriodoActualizado": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "fechaCierre": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "pagoCierre": { "type": "string", "maxLength": 21 }, "quita": { "type": "string", "maxLength": 21 }, "dacion": { "type": "string", "maxLength": 21 }, "quebranto": { "type": "string", "maxLength": 21 }, "historicoPagos": { "type": "string", "maxLength": 24 }, "atrasoMayor": { "type": "string", "maxLength": 3 }, "registroImpugnado": { "type": "string", "maxLength": 2 }, "historiaDias": { "type": "string", "maxLength": 36 }, "numeroPagos": { "type": "string", "maxLength": 4 }, "frecuenciaPagos": { "type": "string", "maxLength": 5 }, "montoPago": { "type": "string", "maxLength": 20 }, "fechaUltimoPago": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaReestructura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaPrimerIncumplimiento": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "saldoInsoluto": { "type": "string", "maxLength": 20 }, "creditoMaximoUtilizado": { "type": "string", "maxLength": 20 }, "fechaIngresoCarteraVencida": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoResponsabilidad": { "type": "string", "maxLength": 3 } } } }, {} ] }, "historia": { "anyOf": [ { "type": "object", "title": "historia", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "periodo": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoA90Dias": { "type": "string", "maxLength": 21 }, "calificacioncartera": { "type": "string", "maxLength": 56 }, "maximoSaldoVencido": { "type": "string", "maxLength": 21 }, "mayorNumeroDiasVencido": { "type": "string", "maxLength": 3 } } }, { "type": "array", "items": { "type": "object", "title": "historia", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "periodo": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoA90Dias": { "type": "string", "maxLength": 21 }, "calificacioncartera": { "type": "string", "maxLength": 56 }, "maximoSaldoVencido": { "type": "string", "maxLength": 21 }, "mayorNumeroDiasVencido": { "type": "string", "maxLength": 3 } } } }, {} ] }, "creditoComercial": { "anyOf": [ { "type": "object", "title": "creditoComercial", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "otorgante": { "type": "string", "maxLength": 6 }, "total": { "type": "string", "maxLength": 6 }, "vigente": { "type": "string", "maxLength": 6 }, "vencido": { "type": "string", "maxLength": 6 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 6 }, "fechaUltimoReporte": { "type": "string", "maxLength": 6, "description": "The format is MMYYYY" }, "maximoSaldo": { "type": "string", "maxLength": 6 }, "saldoPromedio": { "type": "string", "maxLength": 25 }, "historicoPagos": { "type": "string", "maxLength": 25 }, "regImpugnado": { "type": "string", "maxLength": 2, "description": "Si en este campo se presenta el valor “RI”, significa que el registro está impugnado por el Cliente" } } }, { "type": "array", "items": { "type": "object", "title": "creditoComercial", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "otorgante": { "type": "string", "maxLength": 6 }, "total": { "type": "string", "maxLength": 6 }, "vigente": { "type": "string", "maxLength": 6 }, "vencido": { "type": "string", "maxLength": 6 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 6 }, "fechaUltimoReporte": { "type": "string", "maxLength": 6, "description": "The format is MMYYYY" }, "maximoSaldo": { "type": "string", "maxLength": 6 }, "saldoPromedio": { "type": "string", "maxLength": 25 }, "historicoPagos": { "type": "string", "maxLength": 25 }, "regImpugnado": { "type": "string", "maxLength": 2, "description": "Si en este campo se presenta el valor “RI”, significa que el registro está impugnado por el Cliente" } } } }, {} ] }, "califica": { "anyOf": [ { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "clave": { "type": "string", "maxLength": 10 }, "nombre": { "type": "string", "maxLength": 40 }, "valorCaracteristica": { "type": "string", "maxLength": 40 }, "codigoError": { "type": "string", "maxLength": 2 } } }, { "type": "array", "items": { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "clave": { "type": "string", "maxLength": 10 }, "nombre": { "type": "string", "maxLength": 40 }, "valorCaracteristica": { "type": "string", "maxLength": 40 }, "codigoError": { "type": "string", "maxLength": 2 } } } }, {} ] }, "score": { "anyOf": [ { "type": "object", "title": "score", "additionalProperties": false, "properties": { "referenciaConsultado": { "type": "string", "maxLength": 20 }, "codigoScore": { "type": "string", "maxLength": 3 }, "valorScore": { "type": "string", "maxLength": 4 }, "codigoRazon1": { "type": "string", "maxLength": 4 }, "codigoRazon2": { "type": "string", "maxLength": 4 }, "codigoRazon3": { "type": "string", "maxLength": 4 }, "codigoRazon4": { "type": "string", "maxLength": 4 }, "errorScore": { "type": "string", "maxLength": 4 } } }, { "type": "array", "items": { "type": "object", "title": "score", "additionalProperties": false, "properties": { "referenciaConsultado": { "type": "string", "maxLength": 20 }, "codigoScore": { "type": "string", "maxLength": 3 }, "valorScore": { "type": "string", "maxLength": 4 }, "codigoRazon1": { "type": "string", "maxLength": 4 }, "codigoRazon2": { "type": "string", "maxLength": 4 }, "codigoRazon3": { "type": "string", "maxLength": 4 }, "codigoRazon4": { "type": "string", "maxLength": 4 }, "errorScore": { "type": "string", "maxLength": 4 } } } }, {} ] } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "description": "Created response", "additionalProperties": true, "example": { "id": 1, "authentication": "CUSTOM", "service": "bureau_pm", "status": "PENDING", "state": null, "metadata": { "query": { "rfc": "AESE500614JK1", "city": "TLAXCALA", "state": "TLAX", "address": "ZARAGOZA OTE NO 15-A", "country": "MX", "firstname": "MA", "clientType": "PF", "middlename": "ESTELA", "postalCode": "90500", "firstSurname": "ARENAS", "neighborhood": "HUAMANTLA", "secondSurname": "SANCHEZ" }, "clientType": "PF", "reportType": "bureau_pm", "saveResponse": true }, "query": { "consulta": { "encabezado": { "usuario": "999********", "contrasena": "********", "tipoReporte": "INFORME_BURO", "formatoReporte": "XML", "variablesCnbv": "Y", "generarConsolidado": "N", "firmaAutografa": "Y" }, "persona": { "rfc": "AESE500614JK1", "tipoCliente": "PFAE", "primerNombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ" }, "domicilio": { "direccion": "ZARAGOZA OTE NO 15-A", "ciudad": "TLAXCALA", "colonia": "HUAMANTLA", "codigoPostal": "90500", "estado": "TLAX", "pais": "MX" } } }, "response": { "respuesta": { "encabezado": { "identificadorConsulta": "1111", "claveRetorno": "1", "identificadorTransaccion": "0029695657", "fechaConsulta": "09122021" }, "datosGenerales": { "tipoCliente": "2", "rfcCliente": "AESE500614JK1", "nombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ", "direccion1": "ZARAGOZA OTE NO 15-A", "coloniaPoblacion": "HUAMANTLA", "ciudad": "HUAMANTLA", "estado": "TLAX", "codigoPostal": "90500", "pais": "MX", "actividadEconomica1": "31142", "actividadEconomica2": "46611", "actividadEconomica3": "93212", "consultaEntidadFinancieraUltimos3Meses": "0", "consultaEntidadFinancieraUltimos12Meses": "0", "consultaEntidadFinancieraUltimos24Meses": "0", "consultaEntidadFinancieraMas24Meses": "0", "consultaEmpresaComercialUltimos3Meses": "421", "consultaEmpresaComercialUltimos12Meses": "657", "consultaEmpresaComercialUltimos24Meses": "657", "consultaEmpresaComercialMas24Meses": "139", "indicadorInformacionAdicional": "OD", "prevenciones": "0183" }, "hawkHr": { "fechaMensajeHawk": "09122021", "codigoHawk": "000", "descripcionPrevencionHawk": "NO SE ENCONTRO INFORMACION" }, "creditoFinanciero": [ { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002908", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "12326", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "485861", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002907", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "35003", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "81436", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "00000000000283417", "tipoUsuario": "Pruebas BC", "saldoInicial": "40920", "moneda": "001", "apertura": "26061992", "plazo": "1050", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "18985", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "51985", "ultimoPeriodoActualizado": "201107", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" } ], "historia": [ { "rfc": "AESE500614JK1", "periodo": "201712" }, { "rfc": "AESE500614JK1", "periodo": "201801" }, { "rfc": "AESE500614JK1", "periodo": "201802" }, { "rfc": "AESE500614JK1", "periodo": "201803" }, { "rfc": "AESE500614JK1", "periodo": "201804" }, { "rfc": "AESE500614JK1", "periodo": "201805" }, { "rfc": "AESE500614JK1", "periodo": "201806" }, { "rfc": "AESE500614JK1", "periodo": "201807" }, { "rfc": "AESE500614JK1", "periodo": "201808" }, { "rfc": "AESE500614JK1", "periodo": "201809" }, { "rfc": "AESE500614JK1", "periodo": "201810" }, { "rfc": "AESE500614JK1", "periodo": "201811" } ], "califica": [ { "clave": "0", "nombre": "BK12_CLEAN", "valorCaracteristica": "1" }, { "clave": "1", "nombre": "BK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "2", "nombre": "BK12_NUM_TC_ACT", "valorCaracteristica": "0" }, { "clave": "3", "nombre": "NBK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "4", "nombre": "BK12_NUM_EXP_PAIDONTIME", "valorCaracteristica": "--" }, { "clave": "5", "nombre": "BK12_PCT_PROMT", "valorCaracteristica": "--" }, { "clave": "6", "nombre": "NBK12_PCT_PROMT", "valorCaracteristica": "0" }, { "clave": "7", "nombre": "BK12_PCT_SAT", "valorCaracteristica": "--" }, { "clave": "8", "nombre": "NBK12_PCT_SAT", "valorCaracteristica": "0" }, { "clave": "9", "nombre": "BK24_PCT_60PLUS", "valorCaracteristica": "--" }, { "clave": "10", "nombre": "NBK24_PCT_60PLUS", "valorCaracteristica": "1" }, { "clave": "11", "nombre": "NBK12_COMM_PCT_PLUS", "valorCaracteristica": "--" }, { "clave": "12", "nombre": "BK12_PCT_90PLUS", "valorCaracteristica": "--" }, { "clave": "13", "nombre": "BK12_DPD_PROM", "valorCaracteristica": "--" }, { "clave": "14", "nombre": "BK12_IND_QCRA", "valorCaracteristica": "--" }, { "clave": "15", "nombre": "BK12_MAX_CREDIT_AMT", "valorCaracteristica": "--" }, { "clave": "16", "nombre": "MONTHS_ON_FILE_BANKING", "valorCaracteristica": "267" }, { "clave": "17", "nombre": "MONTHS_SINCE_LAST_OPEN_BANKING", "valorCaracteristica": "--" }, { "clave": "18", "nombre": "BK_IND_PMOR", "valorCaracteristica": "0" }, { "clave": "19", "nombre": "BK24_IND_EXP", "valorCaracteristica": "0" }, { "clave": "20", "nombre": "12_INST", "valorCaracteristica": "1" }, { "clave": "21", "nombre": "BK_DEUDA_TOT", "valorCaracteristica": "0" }, { "clave": "22", "nombre": "BK_DEUDA_CP", "valorCaracteristica": "0" }, { "clave": "23", "nombre": "NBK_DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "24", "nombre": "NBK_DEUDA_CP", "valorCaracteristica": "51985" }, { "clave": "25", "nombre": "DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "26", "nombre": "DEUDA_TOT_CP", "valorCaracteristica": "51985" } ] } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-06-20T18:14:18.912Z", "updatedAt": "2023-06-20T19:28:08.039Z", "deletedAt": null, "cachedFrom": null, "uuid": "f8b795b2-ca22-4016-881d-dcf67cf92905" } }, "example": { "id": 1, "authentication": "CUSTOM", "service": "bureau_pm", "status": "PENDING", "state": null, "metadata": { "query": { "rfc": "AESE500614JK1", "city": "TLAXCALA", "state": "TLAX", "address": "ZARAGOZA OTE NO 15-A", "country": "MX", "firstname": "MA", "clientType": "PF", "middlename": "ESTELA", "postalCode": "90500", "firstSurname": "ARENAS", "neighborhood": "HUAMANTLA", "secondSurname": "SANCHEZ" }, "clientType": "PF", "reportType": "bureau_pm", "saveResponse": true }, "query": { "consulta": { "encabezado": { "usuario": "999********", "contrasena": "********", "tipoReporte": "INFORME_BURO", "formatoReporte": "XML", "variablesCnbv": "Y", "generarConsolidado": "N", "firmaAutografa": "Y" }, "persona": { "rfc": "AESE500614JK1", "tipoCliente": "PFAE", "primerNombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ" }, "domicilio": { "direccion": "ZARAGOZA OTE NO 15-A", "ciudad": "TLAXCALA", "colonia": "HUAMANTLA", "codigoPostal": "90500", "estado": "TLAX", "pais": "MX" } } }, "response": { "respuesta": { "encabezado": { "identificadorConsulta": "1111", "claveRetorno": "1", "identificadorTransaccion": "0029695657", "fechaConsulta": "09122021" }, "datosGenerales": { "tipoCliente": "2", "rfcCliente": "AESE500614JK1", "nombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ", "direccion1": "ZARAGOZA OTE NO 15-A", "coloniaPoblacion": "HUAMANTLA", "ciudad": "HUAMANTLA", "estado": "TLAX", "codigoPostal": "90500", "pais": "MX", "actividadEconomica1": "31142", "actividadEconomica2": "46611", "actividadEconomica3": "93212", "consultaEntidadFinancieraUltimos3Meses": "0", "consultaEntidadFinancieraUltimos12Meses": "0", "consultaEntidadFinancieraUltimos24Meses": "0", "consultaEntidadFinancieraMas24Meses": "0", "consultaEmpresaComercialUltimos3Meses": "421", "consultaEmpresaComercialUltimos12Meses": "657", "consultaEmpresaComercialUltimos24Meses": "657", "consultaEmpresaComercialMas24Meses": "139", "indicadorInformacionAdicional": "OD", "prevenciones": "0183" }, "hawkHr": { "fechaMensajeHawk": "09122021", "codigoHawk": "000", "descripcionPrevencionHawk": "NO SE ENCONTRO INFORMACION" }, "creditoFinanciero": [ { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002908", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "12326", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "485861", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002907", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "35003", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "81436", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "00000000000283417", "tipoUsuario": "Pruebas BC", "saldoInicial": "40920", "moneda": "001", "apertura": "26061992", "plazo": "1050", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "18985", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "51985", "ultimoPeriodoActualizado": "201107", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" } ], "historia": [ { "rfc": "AESE500614JK1", "periodo": "201712" }, { "rfc": "AESE500614JK1", "periodo": "201801" }, { "rfc": "AESE500614JK1", "periodo": "201802" }, { "rfc": "AESE500614JK1", "periodo": "201803" }, { "rfc": "AESE500614JK1", "periodo": "201804" }, { "rfc": "AESE500614JK1", "periodo": "201805" }, { "rfc": "AESE500614JK1", "periodo": "201806" }, { "rfc": "AESE500614JK1", "periodo": "201807" }, { "rfc": "AESE500614JK1", "periodo": "201808" }, { "rfc": "AESE500614JK1", "periodo": "201809" }, { "rfc": "AESE500614JK1", "periodo": "201810" }, { "rfc": "AESE500614JK1", "periodo": "201811" } ], "califica": [ { "clave": "0", "nombre": "BK12_CLEAN", "valorCaracteristica": "1" }, { "clave": "1", "nombre": "BK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "2", "nombre": "BK12_NUM_TC_ACT", "valorCaracteristica": "0" }, { "clave": "3", "nombre": "NBK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "4", "nombre": "BK12_NUM_EXP_PAIDONTIME", "valorCaracteristica": "--" }, { "clave": "5", "nombre": "BK12_PCT_PROMT", "valorCaracteristica": "--" }, { "clave": "6", "nombre": "NBK12_PCT_PROMT", "valorCaracteristica": "0" }, { "clave": "7", "nombre": "BK12_PCT_SAT", "valorCaracteristica": "--" }, { "clave": "8", "nombre": "NBK12_PCT_SAT", "valorCaracteristica": "0" }, { "clave": "9", "nombre": "BK24_PCT_60PLUS", "valorCaracteristica": "--" }, { "clave": "10", "nombre": "NBK24_PCT_60PLUS", "valorCaracteristica": "1" }, { "clave": "11", "nombre": "NBK12_COMM_PCT_PLUS", "valorCaracteristica": "--" }, { "clave": "12", "nombre": "BK12_PCT_90PLUS", "valorCaracteristica": "--" }, { "clave": "13", "nombre": "BK12_DPD_PROM", "valorCaracteristica": "--" }, { "clave": "14", "nombre": "BK12_IND_QCRA", "valorCaracteristica": "--" }, { "clave": "15", "nombre": "BK12_MAX_CREDIT_AMT", "valorCaracteristica": "--" }, { "clave": "16", "nombre": "MONTHS_ON_FILE_BANKING", "valorCaracteristica": "267" }, { "clave": "17", "nombre": "MONTHS_SINCE_LAST_OPEN_BANKING", "valorCaracteristica": "--" }, { "clave": "18", "nombre": "BK_IND_PMOR", "valorCaracteristica": "0" }, { "clave": "19", "nombre": "BK24_IND_EXP", "valorCaracteristica": "0" }, { "clave": "20", "nombre": "12_INST", "valorCaracteristica": "1" }, { "clave": "21", "nombre": "BK_DEUDA_TOT", "valorCaracteristica": "0" }, { "clave": "22", "nombre": "BK_DEUDA_CP", "valorCaracteristica": "0" }, { "clave": "23", "nombre": "NBK_DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "24", "nombre": "NBK_DEUDA_CP", "valorCaracteristica": "51985" }, { "clave": "25", "nombre": "DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "26", "nombre": "DEUDA_TOT_CP", "valorCaracteristica": "51985" } ] } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-06-20T18:14:18.912Z", "updatedAt": "2023-06-20T19:28:08.039Z", "deletedAt": null, "cachedFrom": null, "uuid": "f8b795b2-ca22-4016-881d-dcf67cf92905" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "429": { "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "content": { "application/json": { "schema": { "type": "object", "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "properties": { "id": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 429 ] }, "error": { "type": "string", "enum": [ "Too Many Requests" ] }, "message": { "type": "string", "enum": [ "Has excedido el limite de uso de cuenta de moffin. Escribe a soporte de moffin." ] } }, "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } }, { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Failed response of bureau PM service", "additionalProperties": false, "properties": { "respuesta": { "type": "object", "title": "error", "additionalProperties": false, "properties": { "productoSolicitadoErroneo": { "type": "string" }, "segmentoRequeridoNoProporcionado": { "type": "string" }, "campoRequeridoNoProporcionado": { "type": "string" }, "rfcInvalido": { "type": "string" }, "errorIntegrarDatos": { "type": "string" }, "errorGenerarRespuesta": { "type": "string" }, "problemaConexion": { "type": "string" }, "errorEjecucion": { "type": "string" }, "errorDesconocido": { "type": "string" }, "msjError": { "type": "string" } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "title": "Service response" } ] } } } } } } }, "/api/v1/query/bureau_pm/resume/{id}": { "get": { "tags": [ "Query data sources" ], "description": "Get a pending report with its bureau report id", "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Created response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Success response of bureau PM service", "additionalProperties": false, "properties": { "respuesta": { "type": "object", "additionalProperties": false, "properties": { "encabezado": { "type": "object", "title": "encabezado", "additionalProperties": false, "properties": { "identificadorConsulta": { "type": "string" }, "claveRetorno": { "type": "string" }, "identificadorTransaccion": { "type": "string" }, "fechaConsulta": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } }, "datosGenerales": { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "tipoCliente": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "description": "1 - Persona moral. 2 - Persona física con actividad empresarial. 3 - Fondo o fideicomiso. 4 - Gobierno. 5 - Persona moral PyME" }, "rfcCliente": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombre": { "type": "string", "description": "Presenta la razón social de la empresa o el nombre completo del Cliente consultado.", "maxLength": 75 }, "segundoNombre": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "nacionalidad": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "calificacionCartera": { "type": "string", "maxLength": 56 }, "actividadEconomica1": { "type": "string", "maxLength": 11 }, "actividadEconomica2": { "type": "string", "maxLength": 11 }, "actividadEconomica3": { "type": "string", "maxLength": 11 }, "consultaEntidadFinancieraUltimos3Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraUltimos12Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraUltimos24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraMas24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos3Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos12Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialMas24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "indicadorInformacionAdicional": { "type": "string", "maxLength": 4, "description": "Los posibles valores son PR (Personas relacionadas) y OD (Otras direcciones)." }, "prevenciones": { "type": "string", "maxLength": 64 }, "prevencionesPersona": { "type": "string", "maxLength": 64 }, "prevencionesImpug": { "type": "string", "maxLength": 64 }, "prevencionesPersonalImpug": { "type": "string", "maxLength": 64 } } }, "hawkHr": { "anyOf": [ { "type": "object", "title": "hawkHr", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "title": "hawkHr", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "type": "string", "maxLength": 48 } } } }, {} ] }, "hawkHc": { "anyOf": [ { "type": "object", "title": "hawkHc", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "title": "hawkHc", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "maxLength": 48 } } } }, {} ] }, "declarativa": { "type": "object", "title": "declarativa", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "declarativa1": { "type": "string", "maxLength": 99 }, "declarativa2": { "type": "string", "maxLength": 99 }, "declarativa3": { "type": "string", "maxLength": 99 }, "declarativa4": { "type": "string", "maxLength": 99 }, "declarativa5": { "type": "string", "maxLength": 99 }, "declarativa6": { "type": "string", "maxLength": 99 }, "declarativa7": { "type": "string", "maxLength": 99 }, "declarativa8": { "type": "string", "maxLength": 99 }, "declarativa9": { "type": "string", "maxLength": 99 }, "declarativa10": { "type": "string", "maxLength": 99 }, "declarativa11": { "type": "string", "maxLength": 99 }, "declarativa12": { "type": "string", "maxLength": 99 }, "declarativa13": { "type": "string", "maxLength": 99 }, "declarativa14": { "type": "string", "maxLength": 99 }, "declarativa15": { "type": "string", "maxLength": 99 }, "declarativa16": { "type": "string", "maxLength": 99 }, "declarativa17": { "type": "string", "maxLength": 99 }, "declarativa18": { "type": "string", "maxLength": 99 }, "declarativa19": { "type": "string", "maxLength": 99 }, "declarativa20": { "type": "string", "maxLength": 99 }, "declarativa21": { "type": "string", "maxLength": 99 }, "fechaDeclarativa": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoDeclarativa": { "type": "string", "maxLength": 3 }, "tipoOtorgante": { "type": "string", "maxLength": 3 }, "numeroContrato": { "type": "string", "maxLength": 25 }, "tipoCredito": { "type": "string", "maxLength": 4 } } }, "accionista": { "anyOf": [ { "type": "object", "title": "accionista", "additionalProperties": false, "properties": { "tipoPersona": { "type": "string", "enum": [ "1", "2" ], "description": "1 (Accionista) y 2 (Avalista de)" }, "rfc": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombreAccionista": { "type": "string", "maxLength": 75 }, "segundoNombre": { "type": "string", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "porcentaje": { "type": "string", "maxLength": 2 }, "cantidadAvalada": { "type": "string", "maxLength": 21 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 99 }, "fechaRegistroAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaRegistroAvalista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaAperturaCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } }, { "type": "array", "items": { "type": "object", "title": "accionista", "additionalProperties": false, "properties": { "tipoPersona": { "type": "string", "enum": [ "1", "2" ], "description": "1 (Accionista) y 2 (Avalista de)" }, "rfc": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombreAccionista": { "type": "string", "maxLength": 75 }, "segundoNombre": { "type": "string", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "porcentaje": { "type": "string", "maxLength": 2 }, "cantidadAvalada": { "type": "string", "maxLength": 21 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 99 }, "fechaRegistroAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaRegistroAvalista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaAperturaCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } } }, {} ] }, "creditoFinanciero": { "anyOf": [ { "type": "object", "title": "creditoFinanciero", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "numeroCuenta": { "type": "string", "maxLength": 25 }, "tipoUsuario": { "type": "string", "maxLength": 99 }, "saldoInicial": { "type": "string", "maxLength": 20 }, "moneda": { "type": "string", "maxLength": 3 }, "apertura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "plazo": { "type": "string", "maxLength": 5 }, "tipoCambio": { "type": "string", "maxLength": 21 }, "claveObservacion": { "type": "string", "maxLength": 4 }, "tipoCredito": { "type": "string", "maxLength": 4 }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 21 }, "ultimoPeriodoActualizado": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "fechaCierre": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "pagoCierre": { "type": "string", "maxLength": 21 }, "quita": { "type": "string", "maxLength": 21 }, "dacion": { "type": "string", "maxLength": 21 }, "quebranto": { "type": "string", "maxLength": 21 }, "historicoPagos": { "type": "string", "maxLength": 24 }, "atrasoMayor": { "type": "string", "maxLength": 3 }, "registroImpugnado": { "type": "string", "maxLength": 2 }, "historiaDias": { "type": "string", "maxLength": 36 }, "numeroPagos": { "type": "string", "maxLength": 4 }, "frecuenciaPagos": { "type": "string", "maxLength": 5 }, "montoPago": { "type": "string", "maxLength": 20 }, "fechaUltimoPago": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaReestructura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaPrimerIncumplimiento": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "saldoInsoluto": { "type": "string", "maxLength": 20 }, "creditoMaximoUtilizado": { "type": "string", "maxLength": 20 }, "fechaIngresoCarteraVencida": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoResponsabilidad": { "type": "string", "maxLength": 3 } } }, { "type": "array", "items": { "type": "object", "title": "creditoFinanciero", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "numeroCuenta": { "type": "string", "maxLength": 25 }, "tipoUsuario": { "type": "string", "maxLength": 99 }, "saldoInicial": { "type": "string", "maxLength": 20 }, "moneda": { "type": "string", "maxLength": 3 }, "apertura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "plazo": { "type": "string", "maxLength": 5 }, "tipoCambio": { "type": "string", "maxLength": 21 }, "claveObservacion": { "type": "string", "maxLength": 4 }, "tipoCredito": { "type": "string", "maxLength": 4 }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 21 }, "ultimoPeriodoActualizado": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "fechaCierre": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "pagoCierre": { "type": "string", "maxLength": 21 }, "quita": { "type": "string", "maxLength": 21 }, "dacion": { "type": "string", "maxLength": 21 }, "quebranto": { "type": "string", "maxLength": 21 }, "historicoPagos": { "type": "string", "maxLength": 24 }, "atrasoMayor": { "type": "string", "maxLength": 3 }, "registroImpugnado": { "type": "string", "maxLength": 2 }, "historiaDias": { "type": "string", "maxLength": 36 }, "numeroPagos": { "type": "string", "maxLength": 4 }, "frecuenciaPagos": { "type": "string", "maxLength": 5 }, "montoPago": { "type": "string", "maxLength": 20 }, "fechaUltimoPago": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaReestructura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaPrimerIncumplimiento": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "saldoInsoluto": { "type": "string", "maxLength": 20 }, "creditoMaximoUtilizado": { "type": "string", "maxLength": 20 }, "fechaIngresoCarteraVencida": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoResponsabilidad": { "type": "string", "maxLength": 3 } } } }, {} ] }, "historia": { "anyOf": [ { "type": "object", "title": "historia", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "periodo": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoA90Dias": { "type": "string", "maxLength": 21 }, "calificacioncartera": { "type": "string", "maxLength": 56 }, "maximoSaldoVencido": { "type": "string", "maxLength": 21 }, "mayorNumeroDiasVencido": { "type": "string", "maxLength": 3 } } }, { "type": "array", "items": { "type": "object", "title": "historia", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "periodo": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoA90Dias": { "type": "string", "maxLength": 21 }, "calificacioncartera": { "type": "string", "maxLength": 56 }, "maximoSaldoVencido": { "type": "string", "maxLength": 21 }, "mayorNumeroDiasVencido": { "type": "string", "maxLength": 3 } } } }, {} ] }, "creditoComercial": { "anyOf": [ { "type": "object", "title": "creditoComercial", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "otorgante": { "type": "string", "maxLength": 6 }, "total": { "type": "string", "maxLength": 6 }, "vigente": { "type": "string", "maxLength": 6 }, "vencido": { "type": "string", "maxLength": 6 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 6 }, "fechaUltimoReporte": { "type": "string", "maxLength": 6, "description": "The format is MMYYYY" }, "maximoSaldo": { "type": "string", "maxLength": 6 }, "saldoPromedio": { "type": "string", "maxLength": 25 }, "historicoPagos": { "type": "string", "maxLength": 25 }, "regImpugnado": { "type": "string", "maxLength": 2, "description": "Si en este campo se presenta el valor “RI”, significa que el registro está impugnado por el Cliente" } } }, { "type": "array", "items": { "type": "object", "title": "creditoComercial", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "otorgante": { "type": "string", "maxLength": 6 }, "total": { "type": "string", "maxLength": 6 }, "vigente": { "type": "string", "maxLength": 6 }, "vencido": { "type": "string", "maxLength": 6 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 6 }, "fechaUltimoReporte": { "type": "string", "maxLength": 6, "description": "The format is MMYYYY" }, "maximoSaldo": { "type": "string", "maxLength": 6 }, "saldoPromedio": { "type": "string", "maxLength": 25 }, "historicoPagos": { "type": "string", "maxLength": 25 }, "regImpugnado": { "type": "string", "maxLength": 2, "description": "Si en este campo se presenta el valor “RI”, significa que el registro está impugnado por el Cliente" } } } }, {} ] }, "califica": { "anyOf": [ { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "clave": { "type": "string", "maxLength": 10 }, "nombre": { "type": "string", "maxLength": 40 }, "valorCaracteristica": { "type": "string", "maxLength": 40 }, "codigoError": { "type": "string", "maxLength": 2 } } }, { "type": "array", "items": { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "clave": { "type": "string", "maxLength": 10 }, "nombre": { "type": "string", "maxLength": 40 }, "valorCaracteristica": { "type": "string", "maxLength": 40 }, "codigoError": { "type": "string", "maxLength": 2 } } } }, {} ] }, "score": { "anyOf": [ { "type": "object", "title": "score", "additionalProperties": false, "properties": { "referenciaConsultado": { "type": "string", "maxLength": 20 }, "codigoScore": { "type": "string", "maxLength": 3 }, "valorScore": { "type": "string", "maxLength": 4 }, "codigoRazon1": { "type": "string", "maxLength": 4 }, "codigoRazon2": { "type": "string", "maxLength": 4 }, "codigoRazon3": { "type": "string", "maxLength": 4 }, "codigoRazon4": { "type": "string", "maxLength": 4 }, "errorScore": { "type": "string", "maxLength": 4 } } }, { "type": "array", "items": { "type": "object", "title": "score", "additionalProperties": false, "properties": { "referenciaConsultado": { "type": "string", "maxLength": 20 }, "codigoScore": { "type": "string", "maxLength": 3 }, "valorScore": { "type": "string", "maxLength": 4 }, "codigoRazon1": { "type": "string", "maxLength": 4 }, "codigoRazon2": { "type": "string", "maxLength": 4 }, "codigoRazon3": { "type": "string", "maxLength": 4 }, "codigoRazon4": { "type": "string", "maxLength": 4 }, "errorScore": { "type": "string", "maxLength": 4 } } } }, {} ] } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "description": "Created response", "additionalProperties": true, "example": { "id": 1, "authentication": "CUSTOM", "service": "bureau_pm", "status": "PENDING", "state": null, "metadata": { "query": { "rfc": "AESE500614JK1", "city": "TLAXCALA", "state": "TLAX", "address": "ZARAGOZA OTE NO 15-A", "country": "MX", "firstname": "MA", "clientType": "PF", "middlename": "ESTELA", "postalCode": "90500", "firstSurname": "ARENAS", "neighborhood": "HUAMANTLA", "secondSurname": "SANCHEZ" }, "clientType": "PF", "reportType": "bureau_pm", "saveResponse": true }, "query": { "consulta": { "encabezado": { "usuario": "999********", "contrasena": "********", "tipoReporte": "INFORME_BURO", "formatoReporte": "XML", "variablesCnbv": "Y", "generarConsolidado": "N", "firmaAutografa": "Y" }, "persona": { "rfc": "AESE500614JK1", "tipoCliente": "PFAE", "primerNombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ" }, "domicilio": { "direccion": "ZARAGOZA OTE NO 15-A", "ciudad": "TLAXCALA", "colonia": "HUAMANTLA", "codigoPostal": "90500", "estado": "TLAX", "pais": "MX" } } }, "response": { "respuesta": { "encabezado": { "identificadorConsulta": "1111", "claveRetorno": "1", "identificadorTransaccion": "0029695657", "fechaConsulta": "09122021" }, "datosGenerales": { "tipoCliente": "2", "rfcCliente": "AESE500614JK1", "nombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ", "direccion1": "ZARAGOZA OTE NO 15-A", "coloniaPoblacion": "HUAMANTLA", "ciudad": "HUAMANTLA", "estado": "TLAX", "codigoPostal": "90500", "pais": "MX", "actividadEconomica1": "31142", "actividadEconomica2": "46611", "actividadEconomica3": "93212", "consultaEntidadFinancieraUltimos3Meses": "0", "consultaEntidadFinancieraUltimos12Meses": "0", "consultaEntidadFinancieraUltimos24Meses": "0", "consultaEntidadFinancieraMas24Meses": "0", "consultaEmpresaComercialUltimos3Meses": "421", "consultaEmpresaComercialUltimos12Meses": "657", "consultaEmpresaComercialUltimos24Meses": "657", "consultaEmpresaComercialMas24Meses": "139", "indicadorInformacionAdicional": "OD", "prevenciones": "0183" }, "hawkHr": { "fechaMensajeHawk": "09122021", "codigoHawk": "000", "descripcionPrevencionHawk": "NO SE ENCONTRO INFORMACION" }, "creditoFinanciero": [ { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002908", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "12326", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "485861", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002907", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "35003", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "81436", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "00000000000283417", "tipoUsuario": "Pruebas BC", "saldoInicial": "40920", "moneda": "001", "apertura": "26061992", "plazo": "1050", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "18985", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "51985", "ultimoPeriodoActualizado": "201107", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" } ], "historia": [ { "rfc": "AESE500614JK1", "periodo": "201712" }, { "rfc": "AESE500614JK1", "periodo": "201801" }, { "rfc": "AESE500614JK1", "periodo": "201802" }, { "rfc": "AESE500614JK1", "periodo": "201803" }, { "rfc": "AESE500614JK1", "periodo": "201804" }, { "rfc": "AESE500614JK1", "periodo": "201805" }, { "rfc": "AESE500614JK1", "periodo": "201806" }, { "rfc": "AESE500614JK1", "periodo": "201807" }, { "rfc": "AESE500614JK1", "periodo": "201808" }, { "rfc": "AESE500614JK1", "periodo": "201809" }, { "rfc": "AESE500614JK1", "periodo": "201810" }, { "rfc": "AESE500614JK1", "periodo": "201811" } ], "califica": [ { "clave": "0", "nombre": "BK12_CLEAN", "valorCaracteristica": "1" }, { "clave": "1", "nombre": "BK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "2", "nombre": "BK12_NUM_TC_ACT", "valorCaracteristica": "0" }, { "clave": "3", "nombre": "NBK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "4", "nombre": "BK12_NUM_EXP_PAIDONTIME", "valorCaracteristica": "--" }, { "clave": "5", "nombre": "BK12_PCT_PROMT", "valorCaracteristica": "--" }, { "clave": "6", "nombre": "NBK12_PCT_PROMT", "valorCaracteristica": "0" }, { "clave": "7", "nombre": "BK12_PCT_SAT", "valorCaracteristica": "--" }, { "clave": "8", "nombre": "NBK12_PCT_SAT", "valorCaracteristica": "0" }, { "clave": "9", "nombre": "BK24_PCT_60PLUS", "valorCaracteristica": "--" }, { "clave": "10", "nombre": "NBK24_PCT_60PLUS", "valorCaracteristica": "1" }, { "clave": "11", "nombre": "NBK12_COMM_PCT_PLUS", "valorCaracteristica": "--" }, { "clave": "12", "nombre": "BK12_PCT_90PLUS", "valorCaracteristica": "--" }, { "clave": "13", "nombre": "BK12_DPD_PROM", "valorCaracteristica": "--" }, { "clave": "14", "nombre": "BK12_IND_QCRA", "valorCaracteristica": "--" }, { "clave": "15", "nombre": "BK12_MAX_CREDIT_AMT", "valorCaracteristica": "--" }, { "clave": "16", "nombre": "MONTHS_ON_FILE_BANKING", "valorCaracteristica": "267" }, { "clave": "17", "nombre": "MONTHS_SINCE_LAST_OPEN_BANKING", "valorCaracteristica": "--" }, { "clave": "18", "nombre": "BK_IND_PMOR", "valorCaracteristica": "0" }, { "clave": "19", "nombre": "BK24_IND_EXP", "valorCaracteristica": "0" }, { "clave": "20", "nombre": "12_INST", "valorCaracteristica": "1" }, { "clave": "21", "nombre": "BK_DEUDA_TOT", "valorCaracteristica": "0" }, { "clave": "22", "nombre": "BK_DEUDA_CP", "valorCaracteristica": "0" }, { "clave": "23", "nombre": "NBK_DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "24", "nombre": "NBK_DEUDA_CP", "valorCaracteristica": "51985" }, { "clave": "25", "nombre": "DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "26", "nombre": "DEUDA_TOT_CP", "valorCaracteristica": "51985" } ] } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-06-20T18:14:18.912Z", "updatedAt": "2023-06-20T19:28:08.039Z", "deletedAt": null, "cachedFrom": null, "uuid": "f8b795b2-ca22-4016-881d-dcf67cf92905" } }, "example": { "id": 1, "authentication": "CUSTOM", "service": "bureau_pm", "status": "PENDING", "state": null, "metadata": { "query": { "rfc": "AESE500614JK1", "city": "TLAXCALA", "state": "TLAX", "address": "ZARAGOZA OTE NO 15-A", "country": "MX", "firstname": "MA", "clientType": "PF", "middlename": "ESTELA", "postalCode": "90500", "firstSurname": "ARENAS", "neighborhood": "HUAMANTLA", "secondSurname": "SANCHEZ" }, "clientType": "PF", "reportType": "bureau_pm", "saveResponse": true }, "query": { "consulta": { "encabezado": { "usuario": "999********", "contrasena": "********", "tipoReporte": "INFORME_BURO", "formatoReporte": "XML", "variablesCnbv": "Y", "generarConsolidado": "N", "firmaAutografa": "Y" }, "persona": { "rfc": "AESE500614JK1", "tipoCliente": "PFAE", "primerNombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ" }, "domicilio": { "direccion": "ZARAGOZA OTE NO 15-A", "ciudad": "TLAXCALA", "colonia": "HUAMANTLA", "codigoPostal": "90500", "estado": "TLAX", "pais": "MX" } } }, "response": { "respuesta": { "encabezado": { "identificadorConsulta": "1111", "claveRetorno": "1", "identificadorTransaccion": "0029695657", "fechaConsulta": "09122021" }, "datosGenerales": { "tipoCliente": "2", "rfcCliente": "AESE500614JK1", "nombre": "MA", "segundoNombre": "ESTELA", "apellidoPaterno": "ARENAS", "apellidoMaterno": "SANCHEZ", "direccion1": "ZARAGOZA OTE NO 15-A", "coloniaPoblacion": "HUAMANTLA", "ciudad": "HUAMANTLA", "estado": "TLAX", "codigoPostal": "90500", "pais": "MX", "actividadEconomica1": "31142", "actividadEconomica2": "46611", "actividadEconomica3": "93212", "consultaEntidadFinancieraUltimos3Meses": "0", "consultaEntidadFinancieraUltimos12Meses": "0", "consultaEntidadFinancieraUltimos24Meses": "0", "consultaEntidadFinancieraMas24Meses": "0", "consultaEmpresaComercialUltimos3Meses": "421", "consultaEmpresaComercialUltimos12Meses": "657", "consultaEmpresaComercialUltimos24Meses": "657", "consultaEmpresaComercialMas24Meses": "139", "indicadorInformacionAdicional": "OD", "prevenciones": "0183" }, "hawkHr": { "fechaMensajeHawk": "09122021", "codigoHawk": "000", "descripcionPrevencionHawk": "NO SE ENCONTRO INFORMACION" }, "creditoFinanciero": [ { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002908", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "12326", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "485861", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "185002907", "tipoUsuario": "Pruebas BC", "saldoInicial": "116000", "moneda": "001", "apertura": "01011980", "plazo": "1", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "35003", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "81436", "ultimoPeriodoActualizado": "201106", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" }, { "rfcCliente": "AESE500614JK1", "numeroCuenta": "00000000000283417", "tipoUsuario": "Pruebas BC", "saldoInicial": "40920", "moneda": "001", "apertura": "26061992", "plazo": "1050", "tipoCambio": "1.00", "claveObservacion": "SG", "tipoCredito": "1305", "saldoVigente": "18985", "saldoVencidoDe1a29Dias": "0", "saldoVencidoDe30a59Dias": "0", "saldoVencidoDe60a89Dias": "0", "saldoVencidoDe90a119Dias": "0", "saldoVencidoDe120a179Dias": "0", "saldoVencidoDe180DiasOMas": "51985", "ultimoPeriodoActualizado": "201107", "historicoPagos": "777777777777777777777777", "atrasoMayor": "999" } ], "historia": [ { "rfc": "AESE500614JK1", "periodo": "201712" }, { "rfc": "AESE500614JK1", "periodo": "201801" }, { "rfc": "AESE500614JK1", "periodo": "201802" }, { "rfc": "AESE500614JK1", "periodo": "201803" }, { "rfc": "AESE500614JK1", "periodo": "201804" }, { "rfc": "AESE500614JK1", "periodo": "201805" }, { "rfc": "AESE500614JK1", "periodo": "201806" }, { "rfc": "AESE500614JK1", "periodo": "201807" }, { "rfc": "AESE500614JK1", "periodo": "201808" }, { "rfc": "AESE500614JK1", "periodo": "201809" }, { "rfc": "AESE500614JK1", "periodo": "201810" }, { "rfc": "AESE500614JK1", "periodo": "201811" } ], "califica": [ { "clave": "0", "nombre": "BK12_CLEAN", "valorCaracteristica": "1" }, { "clave": "1", "nombre": "BK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "2", "nombre": "BK12_NUM_TC_ACT", "valorCaracteristica": "0" }, { "clave": "3", "nombre": "NBK12_NUM_CRED", "valorCaracteristica": "0" }, { "clave": "4", "nombre": "BK12_NUM_EXP_PAIDONTIME", "valorCaracteristica": "--" }, { "clave": "5", "nombre": "BK12_PCT_PROMT", "valorCaracteristica": "--" }, { "clave": "6", "nombre": "NBK12_PCT_PROMT", "valorCaracteristica": "0" }, { "clave": "7", "nombre": "BK12_PCT_SAT", "valorCaracteristica": "--" }, { "clave": "8", "nombre": "NBK12_PCT_SAT", "valorCaracteristica": "0" }, { "clave": "9", "nombre": "BK24_PCT_60PLUS", "valorCaracteristica": "--" }, { "clave": "10", "nombre": "NBK24_PCT_60PLUS", "valorCaracteristica": "1" }, { "clave": "11", "nombre": "NBK12_COMM_PCT_PLUS", "valorCaracteristica": "--" }, { "clave": "12", "nombre": "BK12_PCT_90PLUS", "valorCaracteristica": "--" }, { "clave": "13", "nombre": "BK12_DPD_PROM", "valorCaracteristica": "--" }, { "clave": "14", "nombre": "BK12_IND_QCRA", "valorCaracteristica": "--" }, { "clave": "15", "nombre": "BK12_MAX_CREDIT_AMT", "valorCaracteristica": "--" }, { "clave": "16", "nombre": "MONTHS_ON_FILE_BANKING", "valorCaracteristica": "267" }, { "clave": "17", "nombre": "MONTHS_SINCE_LAST_OPEN_BANKING", "valorCaracteristica": "--" }, { "clave": "18", "nombre": "BK_IND_PMOR", "valorCaracteristica": "0" }, { "clave": "19", "nombre": "BK24_IND_EXP", "valorCaracteristica": "0" }, { "clave": "20", "nombre": "12_INST", "valorCaracteristica": "1" }, { "clave": "21", "nombre": "BK_DEUDA_TOT", "valorCaracteristica": "0" }, { "clave": "22", "nombre": "BK_DEUDA_CP", "valorCaracteristica": "0" }, { "clave": "23", "nombre": "NBK_DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "24", "nombre": "NBK_DEUDA_CP", "valorCaracteristica": "51985" }, { "clave": "25", "nombre": "DEUDA_TOT", "valorCaracteristica": "51985" }, { "clave": "26", "nombre": "DEUDA_TOT_CP", "valorCaracteristica": "51985" } ] } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-06-20T18:14:18.912Z", "updatedAt": "2023-06-20T19:28:08.039Z", "deletedAt": null, "cachedFrom": null, "uuid": "f8b795b2-ca22-4016-881d-dcf67cf92905" } } } }, "304": { "description": "Empty response" }, "401": { "description": "Unauthorized response", "content": { "application/json": { "schema": { "type": "object", "description": "Unauthorized response", "properties": { "statusCode": { "type": "number", "enum": [ 401 ] }, "error": { "type": "string", "enum": [ "Unauthorized" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "409": { "description": "Conflict response", "content": { "application/json": { "schema": { "type": "object", "description": "Conflict response", "properties": { "id": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 409 ] }, "error": { "type": "string", "enum": [ "Conflict" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "500": { "description": "Error schema", "content": { "application/json": { "schema": { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } } } } } } } }, "/api/v1/query/bureau_pf_intl": { "post": { "tags": [ "Query data sources" ], "description": "Bureau \"persona fisica INTL\" report", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "intlRequest": { "type": "string" }, "intlResponse": { "type": "string" }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "externalId": { "type": "string", "description": "ID to identify the ServiceQuery in your system" } } } }, "required": [ "intlRequest", "intlResponse" ] } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of Bureau \"persona fisica\" report", "nullable": true, "additionalProperties": false, "properties": { "return": { "type": "object", "properties": { "Personas": { "type": "object", "properties": { "Persona": { "anyOf": [ { "type": "object", "properties": { "Encabezado": { "type": "object", "properties": { "Version": { "type": "string", "maxLength": 2, "enum": [ "11", "12", "13" ] }, "NumeroReferenciaOperador": { "type": "string", "maxLength": 25 }, "ClavePais": { "type": "string", "maxLength": 2 }, "IdentificadorBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "ClaveRetornoConsumidorPrincipal": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "ClaveRetornoConsumidorSecundario": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "NumeroControlConsulta": { "type": "string", "maxLength": 99 } } }, "Nombre": { "type": "object", "properties": { "ApellidoPaterno": { "type": "string", "maxLength": 26 }, "ApellidoMaterno": { "type": "string", "maxLength": 26 }, "ApellidoAdicional": { "type": "string", "maxLength": 26 }, "PrimerNombre": { "type": "string", "maxLength": 26 }, "SegundoNombre": { "type": "string", "maxLength": 26 }, "FechaNacimiento": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RFC": { "type": "string", "maxLength": 13 }, "Prefijo": { "type": "string", "maxLength": 4, "description": "Se refiere a valores tales como: Sr, Sra, Srta, Lic, Dr, etc" }, "Sufijo": { "type": "string", "maxLength": 4, "enum": [ "JR", "II", "III" ], "description": "JR (Junior), II (Segundo) y III (Tercero)" }, "Nacionalidad": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "Residencia": { "type": "string", "maxLength": 1, "enum": [ "1", "2", "3" ], "description": "1 (Propietario), 2 (Renta) y 3 (Pensión / Vive con familiares)" }, "NumeroLicenciaConducir": { "type": "string", "maxLength": 20 }, "EstadoCivil": { "type": "string", "maxLength": 1, "enum": [ "D", "F", "M", "S", "W" ], "description": "D (Divorciado), F (Unión Libre), M (Casado), S (Soltero) y W (Viudo)" }, "Sexo": { "type": "string", "maxLength": 1, "enum": [ "F", "M" ], "description": "F (Femenino) y M (Masculino)" }, "NumeroCedulaProfesional": { "type": "string", "maxLength": 20 }, "NumeroRegistroElectoral": { "type": "string", "maxLength": 20 }, "ClaveImpuestosOtroPais": { "type": "string", "maxLength": 20 }, "ClaveOtroPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "NumeroDependientes": { "type": "string", "maxLength": 2 }, "EdadesDependientes": { "type": "string", "maxLength": 30, "description": "Se ingresan usando 2 caracteres para cada edad, se permiten hasta 15 consecutivas" }, "FechaRecepcionInformacionDependientes": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaDefuncion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, "Domicilios": { "type": "object", "properties": { "Domicilio": { "anyOf": [ { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Empleos": { "type": "object", "properties": { "Empleo": { "anyOf": [ { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Cuentas": { "type": "object", "properties": { "Cuenta": { "anyOf": [ { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } } }, {} ] } } }, "ConsultasEfectuadas": { "type": "object", "properties": { "ConsultaEfectuada": { "anyOf": [ { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } } }, {} ] } } }, "ResumenReporte": { "type": "object", "properties": { "ResumenReporte": { "anyOf": [ { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } } }, {} ] } } }, "HawkAlertConsulta": { "type": "object", "properties": { "HawkAlertC": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "HawkAlertBD": { "type": "object", "properties": { "HawkAlertBD": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "DeclaracionesCliente": { "type": "object", "properties": { "DeclaracionConsumidor": { "anyOf": [ { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } }, { "type": "array", "items": { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } } }, {} ] } } }, "ScoreBuroCredito": { "type": "object", "properties": { "ScoreBC": { "anyOf": [ { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } }, { "type": "array", "items": { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } } }, {} ] } } }, "CuentaC": { "type": "array", "items": { "type": "object", "properties": { "NumeroCuenta": { "type": "string", "maxLength": 26 }, "ClaveOtorgante": { "type": "string", "maxLength": 10, "nullable": true }, "NombreOtorgante": { "type": "string", "maxLength": 16, "nullable": true } } } } } }, { "type": "array", "items": { "type": "object", "properties": { "Encabezado": { "type": "object", "properties": { "Version": { "type": "string", "maxLength": 2, "enum": [ "11", "12", "13" ] }, "NumeroReferenciaOperador": { "type": "string", "maxLength": 25 }, "ClavePais": { "type": "string", "maxLength": 2 }, "IdentificadorBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "ClaveRetornoConsumidorPrincipal": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "ClaveRetornoConsumidorSecundario": { "type": "string", "maxLength": 1, "enum": [ "0", "1" ] }, "NumeroControlConsulta": { "type": "string", "maxLength": 99 } } }, "Nombre": { "type": "object", "properties": { "ApellidoPaterno": { "type": "string", "maxLength": 26 }, "ApellidoMaterno": { "type": "string", "maxLength": 26 }, "ApellidoAdicional": { "type": "string", "maxLength": 26 }, "PrimerNombre": { "type": "string", "maxLength": 26 }, "SegundoNombre": { "type": "string", "maxLength": 26 }, "FechaNacimiento": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RFC": { "type": "string", "maxLength": 13 }, "Prefijo": { "type": "string", "maxLength": 4, "description": "Se refiere a valores tales como: Sr, Sra, Srta, Lic, Dr, etc" }, "Sufijo": { "type": "string", "maxLength": 4, "enum": [ "JR", "II", "III" ], "description": "JR (Junior), II (Segundo) y III (Tercero)" }, "Nacionalidad": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "Residencia": { "type": "string", "maxLength": 1, "enum": [ "1", "2", "3" ], "description": "1 (Propietario), 2 (Renta) y 3 (Pensión / Vive con familiares)" }, "NumeroLicenciaConducir": { "type": "string", "maxLength": 20 }, "EstadoCivil": { "type": "string", "maxLength": 1, "enum": [ "D", "F", "M", "S", "W" ], "description": "D (Divorciado), F (Unión Libre), M (Casado), S (Soltero) y W (Viudo)" }, "Sexo": { "type": "string", "maxLength": 1, "enum": [ "F", "M" ], "description": "F (Femenino) y M (Masculino)" }, "NumeroCedulaProfesional": { "type": "string", "maxLength": 20 }, "NumeroRegistroElectoral": { "type": "string", "maxLength": 20 }, "ClaveImpuestosOtroPais": { "type": "string", "maxLength": 20 }, "ClaveOtroPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "NumeroDependientes": { "type": "string", "maxLength": 2 }, "EdadesDependientes": { "type": "string", "maxLength": 30, "description": "Se ingresan usando 2 caracteres para cada edad, se permiten hasta 15 consecutivas" }, "FechaRecepcionInformacionDependientes": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaDefuncion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, "Domicilios": { "type": "object", "properties": { "Domicilio": { "anyOf": [ { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "FechaResidencia": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "TipoDomicilio": { "type": "string", "maxLength": 1, "enum": [ "B", "C", "H", "P" ], "description": "B (Negocio), C (Domicilio del usuario), H (Casa) y P (Apartado postal)" }, "FechaReporteDireccion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Empleos": { "type": "object", "properties": { "Empleo": { "anyOf": [ { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "NombreEmpresa": { "type": "string", "maxLength": 40 }, "Direccion1": { "type": "string", "maxLength": 40 }, "Direccion2": { "type": "string", "maxLength": 40 }, "ColoniaPoblacion": { "type": "string", "maxLength": 40 }, "DelegacionMunicipio": { "type": "string", "maxLength": 40 }, "Ciudad": { "type": "string", "maxLength": 40 }, "Estado": { "type": "string", "maxLength": 4, "enum": [ "AGS", "BCN", "BCS", "CAM", "CDMX", "CHS", "CHI", "COA", "COL", "DGO", "EM", "GTO", "GRO", "HGO", "JAL", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "CP": { "type": "string", "maxLength": 5 }, "NumeroTelefono": { "type": "string", "maxLength": 11 }, "Extension": { "type": "string", "maxLength": 8 }, "Fax": { "type": "string", "maxLength": 11 }, "Cargo": { "type": "string", "maxLength": 30 }, "FechaContratacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "Salario": { "type": "string", "maxLength": 9 }, "BaseSalarial": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "S", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Por hora), K (Catorcenal, M (Mensual), S (Quincenal), W (Semanal) e Y (Anual)" }, "NumeroEmpleado": { "type": "string", "maxLength": 15 }, "FechaUltimoDiaEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReportoEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaVerificacionEmpleo": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoVerificacion": { "type": "string", "maxLength": 1, "enum": [ "A", "M" ], "description": "A (Automatizado) y M (Manual)" }, "CodPais": { "type": "string", "maxLength": 2, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] } } } }, {} ] } } }, "Cuentas": { "type": "object", "properties": { "Cuenta": { "anyOf": [ { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaActualizacion": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "RegistoImpugnado": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "NumeroTelefonoOtorgante": { "type": "string", "maxLength": 11 }, "IdentificadorSociedadInformacionCrediticia": { "type": "string", "maxLength": 11 }, "NumeroCuentaActual": { "type": "string", "maxLength": 25 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "TipoCuenta": { "type": "string", "maxLength": 1, "enum": [ "I", "M", "O", "R", "X" ], "description": "I (Pagos fijos), M (Hipoteca), O (Sin limite preestablecido), R (Revolvente) y X (Reportado en D&B - solo personas morales)" }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ValorActivoValuacion": { "type": "string", "maxLength": 9 }, "NumeroPagos": { "type": "string", "maxLength": 4 }, "FrecuenciaPagos": { "type": "string", "maxLength": 1, "enum": [ "B", "D", "H", "K", "M", "P", "Q", "S", "V", "W", "Y" ], "description": "B (Bimestral), D (Diario), H (Semestral), K (Catorcenal), M (Mensual), P (Deducción del salario), Q (Trimestral), S (Quincenal), V (Variable), W (Semanal) e Y (Anual)" }, "MontoPagar": { "type": "string", "maxLength": 9 }, "FechaAperturaCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimoPago": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaUltimaCompra": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaCierreCuenta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ModoReportar": { "type": "string", "maxLength": 1, "enum": [ "A", "M", "C" ], "description": "A (Automatizado), M (Manual) y C (Confin)" }, "UltimaFechaSaldoCero": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "Garantia": { "type": "string", "maxLength": 40 }, "CreditoMaximo": { "type": "string", "maxLength": 9 }, "SaldoActual": { "type": "string", "maxLength": 10 }, "LimiteCredito": { "type": "string", "maxLength": 9 }, "SaldoVencido": { "type": "string", "maxLength": 9 }, "NumeroPagosVencidos": { "type": "string", "maxLength": 4 }, "FormaPagoActual": { "type": "string", "maxLength": 2, "enum": [ "96", "97", "99", "UR", "00", "01", "02", "03", "04", "05", "06", "07" ] }, "HistoricoPagos": { "type": "string", "maxLength": 24, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "9", "D", "U", "-", " " ] }, "FechaMasRecienteHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaMasAntiguaHistoricoPagos": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "ClaveObservacion": { "type": "string", "maxLength": 2 }, "TotalPagosReportados": { "type": "string", "maxLength": 3 }, "TotalPagosCalificadosMOP2": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP3": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP4": { "type": "string", "maxLength": 2 }, "TotalPagosCalificadosMOP5": { "type": "string", "maxLength": 2 }, "ImporteSaldoMorosidadHistMasGrave": { "type": "string", "maxLength": 9 }, "FechaHistoricaMorosidadMasGrave": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "MopHistoricoMorosidadMasGrave": { "type": "string", "maxLength": 2 }, "MontoUltimoPago": { "type": "string", "maxLength": 9 }, "FechaInicioReestructura": { "type": "string", "maxLength": 9, "enum": [ "RA", "RN", "RV" ] } } } }, {} ] } } }, "ConsultasEfectuadas": { "type": "object", "properties": { "ConsultaEfectuada": { "anyOf": [ { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaConsulta": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "IdentificacionBuro": { "type": "string", "maxLength": 4 }, "ClaveOtorgante": { "type": "string", "maxLength": 10 }, "NombreOtorgante": { "type": "string", "maxLength": 16 }, "TelefonoOtorgante": { "type": "string", "maxLength": 11 }, "TipoContrato": { "type": "string", "maxLength": 2, "enum": [ "AF", "AG", "AL", "AP", "AU", "BD", "BT", "CC", "CE", "CF", "CL", "CO", "CS", "CT", "DE", "EQ", "FI", "FT", "HA", "HE", "HI", "LS", "LR", "MI", "OA", "PA", "PB", "PG", "PL", "PN", "PQ", "PR", "PS", "RC", "RD", "RE", "RF", "RN", "RV", "SC", "SE", "SG", "SM", "ST", "TE", "UK", "US" ] }, "ClaveUnidadMonetaria": { "type": "string", "maxLength": 2, "enum": [ "MX", "N$", "US", "UD" ], "description": "MX / N$ (Pesos mexicanos), US (Dólares) y UD (Unidades de inversión" }, "ImporteContrato": { "type": "string", "maxLength": 9 }, "IndicadorTipoResponsabilidad": { "type": "string", "maxLength": 1, "enum": [ "A", "I", "J", "C" ], "description": "A (Usuario autorizado), I (Individual), J (Mancomunado) y C (Obligado solidario)" }, "ConsumidorNuevo": { "type": "string", "maxLength": 1 }, "ResultadoFinal": { "type": "string", "maxLength": 25 }, "IdentificadorOrigenConsulta": { "type": "string", "maxLength": 25, "enum": [ "0", "1", "2" ], "description": "0 (Buró de crédito), 1 (Círculo de crédito) y 2 (para uso futuro)" } } } }, {} ] } } }, "ResumenReporte": { "type": "object", "properties": { "ResumenReporte": { "anyOf": [ { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaIngresoBD": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroMOP7": { "type": "string", "maxLength": 2 }, "NumeroMOP6": { "type": "string", "maxLength": 2 }, "NumeroMOP5": { "type": "string", "maxLength": 2 }, "NumeroMOP4": { "type": "string", "maxLength": 2 }, "NumeroMOP3": { "type": "string", "maxLength": 2 }, "NumeroMOP2": { "type": "string", "maxLength": 2 }, "NumeroMOP1": { "type": "string", "maxLength": 2 }, "NumeroMOP0": { "type": "string", "maxLength": 2 }, "NumeroMOPUR": { "type": "string", "maxLength": 2 }, "NumeroCuentas": { "type": "string", "maxLength": 4 }, "CuentasPagosFijosHipotecas": { "type": "string", "maxLength": 4 }, "CuentasRevolventesAbiertas": { "type": "string", "maxLength": 4 }, "CuentasCerradas": { "type": "string", "maxLength": 4 }, "CuentasNegativasActuales": { "type": "string", "maxLength": 4 }, "CuentasClavesHistoriaNegativa": { "type": "string", "maxLength": 4 }, "CuentasDisputa": { "type": "string", "maxLength": 2 }, "NumeroSolicitudesUltimos6Meses": { "type": "string", "maxLength": 2 }, "NuevaDireccionReportadaUltimos60Dias": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "MensajesAlerta": { "type": "string", "maxLength": 8 }, "ExistenciaDeclaracionesConsumidor": { "type": "string", "maxLength": 1, "enum": [ "Y", "N" ], "description": "Y (si) y N (no)" }, "TipoMoneda": { "type": "string", "maxLength": 2, "enum": [ "MX", "US", "UD" ], "description": "MX (Pesos mexicanos, incluye N$), US (Dólares) y UD (Unidades de inversión" }, "TotalCreditosMaximosRevolventes": { "type": "string", "maxLength": 9 }, "TotalLimitesCreditoRevolventes": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesRevolventes": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosRevolventes": { "type": "string", "maxLength": 9 }, "TotalPagosRevolventes": { "type": "string", "maxLength": 9 }, "PctLimiteCreditoUtilizadoRevolventes": { "type": "string", "maxLength": 3 }, "TotalCreditosMaximosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalSaldosActualesPagosFijos": { "type": "string", "maxLength": 10 }, "TotalSaldosVencidosPagosFijos": { "type": "string", "maxLength": 9 }, "TotalPagosPagosFijos": { "type": "string", "maxLength": 9 }, "NumeroMOP96": { "type": "string", "maxLength": 2 }, "NumeroMOP97": { "type": "string", "maxLength": 2 }, "NumeroMOP99": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasAntigua": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "FechaAperturaCuentaMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "TotalSolicitudesReporte": { "type": "string", "maxLength": 2 }, "FechaSolicitudReporteMasReciente": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalCuentasDespachoCobranza": { "type": "string", "maxLength": 2 }, "FechaAperturaCuentaMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "NumeroTotalSolicitudesDespachosCobranza": { "type": "string", "maxLength": 2 }, "FechaSolicitudMasRecienteDespachoCobranza": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" } } } }, {} ] } } }, "HawkAlertConsulta": { "type": "object", "properties": { "HawkAlertC": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "HawkAlertBD": { "type": "object", "properties": { "HawkAlertBD": { "anyOf": [ { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "properties": { "FechaReporte": { "type": "string", "maxLength": 8, "description": "El formato es DDMMYYYY" }, "CodigoClave": { "type": "string", "maxLength": 3 }, "TipoInstitucion": { "type": "string", "maxLength": 16 }, "Mensaje": { "type": "string", "maxLength": 48 } } } }, {} ] } } }, "DeclaracionesCliente": { "type": "object", "properties": { "DeclaracionConsumidor": { "anyOf": [ { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } }, { "type": "array", "items": { "type": "object", "properties": { "DeclaracionConsumidor": { "type": "string", "maxLength": 2000 } } } }, {} ] } } }, "ScoreBuroCredito": { "type": "object", "properties": { "ScoreBC": { "anyOf": [ { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } }, { "type": "array", "items": { "type": "object", "properties": { "nombreScore": { "type": "string", "maxLength": 30 }, "CodigoScore": { "type": "string", "maxLength": 3, "enum": [ "501", "504", "506", "507", "509", "510", "511", "512", "513", "516", "517", "540", "541", "542", "545", "546", "547", "548", "549", "552", "553", "554", "555", "556", "557", "558", "559", "560", "001", "004", "006", "007", "009", "010", "011", "012", "013", "016", "017", "040", "041", "042", "045", "046", "047", "048", "049", "052", "053", "054", "055", "056", "057", "058", "059", "060" ] }, "ValorScore": { "type": "string", "maxLength": 4 }, "CodigoRazon": { "type": "string", "maxLength": 3 }, "CodigoError": { "type": "string", "maxLength": 2 } } } }, {} ] } } }, "CuentaC": { "type": "array", "items": { "type": "object", "properties": { "NumeroCuenta": { "type": "string", "maxLength": 26 }, "ClaveOtorgante": { "type": "string", "maxLength": 10, "nullable": true }, "NombreOtorgante": { "type": "string", "maxLength": 16, "nullable": true } } } } } } }, {} ] } } } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "429": { "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "content": { "application/json": { "schema": { "type": "object", "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "properties": { "id": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 429 ] }, "error": { "type": "string", "enum": [ "Too Many Requests" ] }, "message": { "type": "string", "enum": [ "Has excedido el limite de uso de cuenta de moffin. Escribe a soporte de moffin." ] } }, "additionalProperties": false } } } }, "500": { "description": "Error schema", "content": { "application/json": { "schema": { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } } } } } } } }, "/api/v1/query/bureau_pm_intl": { "post": { "tags": [ "Query data sources" ], "description": "Bureau \"persona moral INTL\" report", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "intlRequest": { "type": "string" }, "intlResponse": { "type": "string" }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 }, "externalId": { "type": "string", "description": "ID to identify the ServiceQuery in your system" } } } }, "required": [ "intlRequest", "intlResponse" ] } } }, "required": true }, "responses": { "201": { "description": "Success response of bureau PM INTL service", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Success response of bureau PM INTL service", "additionalProperties": false, "properties": { "respuesta": { "type": "object", "additionalProperties": false, "properties": { "encabezado": { "type": "object", "title": "encabezado", "additionalProperties": false, "properties": { "identificadorConsulta": { "type": "string" }, "claveRetorno": { "type": "string" }, "identificadorTransaccion": { "type": "string" }, "fechaConsulta": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } }, "datosGenerales": { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "tipoCliente": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "description": "1 - Persona moral. 2 - Persona física con actividad empresarial. 3 - Fondo o fideicomiso. 4 - Gobierno. 5 - Persona moral PyME" }, "rfcCliente": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombre": { "type": "string", "description": "Presenta la razón social de la empresa o el nombre completo del Cliente consultado.", "maxLength": 75 }, "segundoNombre": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "description": "Aplica unicamente para PFAE", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "nacionalidad": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "calificacionCartera": { "type": "string", "maxLength": 56 }, "actividadEconomica1": { "type": "string", "maxLength": 11 }, "actividadEconomica2": { "type": "string", "maxLength": 11 }, "actividadEconomica3": { "type": "string", "maxLength": 11 }, "consultaEntidadFinancieraUltimos3Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraUltimos12Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraUltimos24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEntidadFinancieraMas24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos3Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos12Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialUltimos24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "consultaEmpresaComercialMas24Meses": { "type": "string", "description": "Number as string", "maxLength": 5 }, "indicadorInformacionAdicional": { "type": "string", "maxLength": 4, "description": "Los posibles valores son PR (Personas relacionadas) y OD (Otras direcciones)." }, "prevenciones": { "type": "string", "maxLength": 64 }, "prevencionesPersona": { "type": "string", "maxLength": 64 }, "prevencionesImpug": { "type": "string", "maxLength": 64 }, "prevencionesPersonalImpug": { "type": "string", "maxLength": 64 } } }, "hawkHr": { "anyOf": [ { "type": "object", "title": "hawkHr", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "type": "string", "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "title": "hawkHr", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "type": "string", "maxLength": 48 } } } }, {} ] }, "hawkHc": { "anyOf": [ { "type": "object", "title": "hawkHc", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "maxLength": 48 } } }, { "type": "array", "items": { "type": "object", "title": "hawkHc", "additionalProperties": false, "properties": { "fechaMensajeHawk": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "codigoHawk": { "type": "string", "maxLength": 3 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 16 }, "descripcionPrevencionHawk": { "maxLength": 48 } } } }, {} ] }, "declarativa": { "type": "object", "title": "declarativa", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "declarativa1": { "type": "string", "maxLength": 99 }, "declarativa2": { "type": "string", "maxLength": 99 }, "declarativa3": { "type": "string", "maxLength": 99 }, "declarativa4": { "type": "string", "maxLength": 99 }, "declarativa5": { "type": "string", "maxLength": 99 }, "declarativa6": { "type": "string", "maxLength": 99 }, "declarativa7": { "type": "string", "maxLength": 99 }, "declarativa8": { "type": "string", "maxLength": 99 }, "declarativa9": { "type": "string", "maxLength": 99 }, "declarativa10": { "type": "string", "maxLength": 99 }, "declarativa11": { "type": "string", "maxLength": 99 }, "declarativa12": { "type": "string", "maxLength": 99 }, "declarativa13": { "type": "string", "maxLength": 99 }, "declarativa14": { "type": "string", "maxLength": 99 }, "declarativa15": { "type": "string", "maxLength": 99 }, "declarativa16": { "type": "string", "maxLength": 99 }, "declarativa17": { "type": "string", "maxLength": 99 }, "declarativa18": { "type": "string", "maxLength": 99 }, "declarativa19": { "type": "string", "maxLength": 99 }, "declarativa20": { "type": "string", "maxLength": 99 }, "declarativa21": { "type": "string", "maxLength": 99 }, "fechaDeclarativa": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoDeclarativa": { "type": "string", "maxLength": 3 }, "tipoOtorgante": { "type": "string", "maxLength": 3 }, "numeroContrato": { "type": "string", "maxLength": 25 }, "tipoCredito": { "type": "string", "maxLength": 4 } } }, "accionista": { "anyOf": [ { "type": "object", "title": "accionista", "additionalProperties": false, "properties": { "tipoPersona": { "type": "string", "enum": [ "1", "2" ], "description": "1 (Accionista) y 2 (Avalista de)" }, "rfc": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombreAccionista": { "type": "string", "maxLength": 75 }, "segundoNombre": { "type": "string", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "porcentaje": { "type": "string", "maxLength": 2 }, "cantidadAvalada": { "type": "string", "maxLength": 21 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 99 }, "fechaRegistroAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaRegistroAvalista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaAperturaCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } }, { "type": "array", "items": { "type": "object", "title": "accionista", "additionalProperties": false, "properties": { "tipoPersona": { "type": "string", "enum": [ "1", "2" ], "description": "1 (Accionista) y 2 (Avalista de)" }, "rfc": { "type": "string", "maxLength": 13 }, "curp": { "type": "string", "maxLength": 18 }, "nombreAccionista": { "type": "string", "maxLength": 75 }, "segundoNombre": { "type": "string", "maxLength": 75 }, "apellidoPaterno": { "type": "string", "maxLength": 25 }, "apellidoMaterno": { "type": "string", "maxLength": 25 }, "direccion1": { "type": "string", "maxLength": 40 }, "direccion2": { "type": "string", "maxLength": 40, "description": "Cuando direccion1 excede los 40 caracteres" }, "coloniaPoblacion": { "type": "string", "maxLength": 60 }, "delegacionMunicipio": { "type": "string", "maxLength": 40 }, "ciudad": { "type": "string", "maxLength": 40 }, "estado": { "type": "string", "maxLength": 40, "enum": [ "AGS", "BCN", "BCS", "CAM", "CHS", "CHI", "CDMX", "COA", "COL", "DGO", "GTO", "GRO", "HGO", "JAL", "EM", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QR", "SLP", "SIN", "SON", "TAB", "TAM", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "maxLength": 10 }, "pais": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ] }, "telefono": { "type": "string", "maxLength": 11 }, "extension": { "type": "string", "maxLength": 8 }, "fax": { "type": "string", "maxLength": 11 }, "porcentaje": { "type": "string", "maxLength": 2 }, "cantidadAvalada": { "type": "string", "maxLength": 21 }, "tipoUsuarioReporta": { "type": "string", "maxLength": 99 }, "fechaRegistroAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionAccionista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaRegistroAvalista": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaActualizacionCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaAperturaCreditoAvalado": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" } } } }, {} ] }, "creditoFinanciero": { "anyOf": [ { "type": "object", "title": "creditoFinanciero", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "numeroCuenta": { "type": "string", "maxLength": 25 }, "tipoUsuario": { "type": "string", "maxLength": 99 }, "saldoInicial": { "type": "string", "maxLength": 20 }, "moneda": { "type": "string", "maxLength": 3 }, "apertura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "plazo": { "type": "string", "maxLength": 5 }, "tipoCambio": { "type": "string", "maxLength": 21 }, "claveObservacion": { "type": "string", "maxLength": 4 }, "tipoCredito": { "type": "string", "maxLength": 4 }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 21 }, "ultimoPeriodoActualizado": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "fechaCierre": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "pagoCierre": { "type": "string", "maxLength": 21 }, "quita": { "type": "string", "maxLength": 21 }, "dacion": { "type": "string", "maxLength": 21 }, "quebranto": { "type": "string", "maxLength": 21 }, "historicoPagos": { "type": "string", "maxLength": 24 }, "atrasoMayor": { "type": "string", "maxLength": 3 }, "registroImpugnado": { "type": "string", "maxLength": 2 }, "historiaDias": { "type": "string", "maxLength": 36 }, "numeroPagos": { "type": "string", "maxLength": 4 }, "frecuenciaPagos": { "type": "string", "maxLength": 5 }, "montoPago": { "type": "string", "maxLength": 20 }, "fechaUltimoPago": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaReestructura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaPrimerIncumplimiento": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "saldoInsoluto": { "type": "string", "maxLength": 20 }, "creditoMaximoUtilizado": { "type": "string", "maxLength": 20 }, "fechaIngresoCarteraVencida": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoResponsabilidad": { "type": "string", "maxLength": 3 } } }, { "type": "array", "items": { "type": "object", "title": "creditoFinanciero", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "numeroCuenta": { "type": "string", "maxLength": 25 }, "tipoUsuario": { "type": "string", "maxLength": 99 }, "saldoInicial": { "type": "string", "maxLength": 20 }, "moneda": { "type": "string", "maxLength": 3 }, "apertura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "plazo": { "type": "string", "maxLength": 5 }, "tipoCambio": { "type": "string", "maxLength": 21 }, "claveObservacion": { "type": "string", "maxLength": 4 }, "tipoCredito": { "type": "string", "maxLength": 4 }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 21 }, "ultimoPeriodoActualizado": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "fechaCierre": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "pagoCierre": { "type": "string", "maxLength": 21 }, "quita": { "type": "string", "maxLength": 21 }, "dacion": { "type": "string", "maxLength": 21 }, "quebranto": { "type": "string", "maxLength": 21 }, "historicoPagos": { "type": "string", "maxLength": 24 }, "atrasoMayor": { "type": "string", "maxLength": 3 }, "registroImpugnado": { "type": "string", "maxLength": 2 }, "historiaDias": { "type": "string", "maxLength": 36 }, "numeroPagos": { "type": "string", "maxLength": 4 }, "frecuenciaPagos": { "type": "string", "maxLength": 5 }, "montoPago": { "type": "string", "maxLength": 20 }, "fechaUltimoPago": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaReestructura": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "fechaPrimerIncumplimiento": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "saldoInsoluto": { "type": "string", "maxLength": 20 }, "creditoMaximoUtilizado": { "type": "string", "maxLength": 20 }, "fechaIngresoCarteraVencida": { "type": "string", "maxLength": 8, "description": "The format is DDMMYYYY" }, "tipoResponsabilidad": { "type": "string", "maxLength": 3 } } } }, {} ] }, "historia": { "anyOf": [ { "type": "object", "title": "historia", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "periodo": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoA90Dias": { "type": "string", "maxLength": 21 }, "calificacioncartera": { "type": "string", "maxLength": 56 }, "maximoSaldoVencido": { "type": "string", "maxLength": 21 }, "mayorNumeroDiasVencido": { "type": "string", "maxLength": 3 } } }, { "type": "array", "items": { "type": "object", "title": "historia", "additionalProperties": false, "properties": { "rfc": { "type": "string", "maxLength": 13 }, "periodo": { "type": "string", "maxLength": 6, "description": "The format is YYYYMM" }, "saldoVigente": { "type": "string", "maxLength": 21 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 21 }, "saldoVencidoA90Dias": { "type": "string", "maxLength": 21 }, "calificacioncartera": { "type": "string", "maxLength": 56 }, "maximoSaldoVencido": { "type": "string", "maxLength": 21 }, "mayorNumeroDiasVencido": { "type": "string", "maxLength": 3 } } } }, {} ] }, "creditoComercial": { "anyOf": [ { "type": "object", "title": "creditoComercial", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "otorgante": { "type": "string", "maxLength": 6 }, "total": { "type": "string", "maxLength": 6 }, "vigente": { "type": "string", "maxLength": 6 }, "vencido": { "type": "string", "maxLength": 6 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 6 }, "fechaUltimoReporte": { "type": "string", "maxLength": 6, "description": "The format is MMYYYY" }, "maximoSaldo": { "type": "string", "maxLength": 6 }, "saldoPromedio": { "type": "string", "maxLength": 25 }, "historicoPagos": { "type": "string", "maxLength": 25 }, "regImpugnado": { "type": "string", "maxLength": 2, "description": "Si en este campo se presenta el valor “RI”, significa que el registro está impugnado por el Cliente" } } }, { "type": "array", "items": { "type": "object", "title": "creditoComercial", "additionalProperties": false, "properties": { "rfcCliente": { "type": "string", "maxLength": 13 }, "otorgante": { "type": "string", "maxLength": 6 }, "total": { "type": "string", "maxLength": 6 }, "vigente": { "type": "string", "maxLength": 6 }, "vencido": { "type": "string", "maxLength": 6 }, "saldoVencidoDe1a29Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe30a59Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe60a89Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe90a119Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe120a179Dias": { "type": "string", "maxLength": 6 }, "saldoVencidoDe180DiasOMas": { "type": "string", "maxLength": 6 }, "fechaUltimoReporte": { "type": "string", "maxLength": 6, "description": "The format is MMYYYY" }, "maximoSaldo": { "type": "string", "maxLength": 6 }, "saldoPromedio": { "type": "string", "maxLength": 25 }, "historicoPagos": { "type": "string", "maxLength": 25 }, "regImpugnado": { "type": "string", "maxLength": 2, "description": "Si en este campo se presenta el valor “RI”, significa que el registro está impugnado por el Cliente" } } } }, {} ] }, "califica": { "anyOf": [ { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "clave": { "type": "string", "maxLength": 10 }, "nombre": { "type": "string", "maxLength": 40 }, "valorCaracteristica": { "type": "string", "maxLength": 40 }, "codigoError": { "type": "string", "maxLength": 2 } } }, { "type": "array", "items": { "type": "object", "title": "datosGenerales", "additionalProperties": false, "properties": { "clave": { "type": "string", "maxLength": 10 }, "nombre": { "type": "string", "maxLength": 40 }, "valorCaracteristica": { "type": "string", "maxLength": 40 }, "codigoError": { "type": "string", "maxLength": 2 } } } }, {} ] }, "score": { "anyOf": [ { "type": "object", "title": "score", "additionalProperties": false, "properties": { "referenciaConsultado": { "type": "string", "maxLength": 20 }, "codigoScore": { "type": "string", "maxLength": 3 }, "valorScore": { "type": "string", "maxLength": 4 }, "codigoRazon1": { "type": "string", "maxLength": 4 }, "codigoRazon2": { "type": "string", "maxLength": 4 }, "codigoRazon3": { "type": "string", "maxLength": 4 }, "codigoRazon4": { "type": "string", "maxLength": 4 }, "errorScore": { "type": "string", "maxLength": 4 } } }, { "type": "array", "items": { "type": "object", "title": "score", "additionalProperties": false, "properties": { "referenciaConsultado": { "type": "string", "maxLength": 20 }, "codigoScore": { "type": "string", "maxLength": 3 }, "valorScore": { "type": "string", "maxLength": 4 }, "codigoRazon1": { "type": "string", "maxLength": 4 }, "codigoRazon2": { "type": "string", "maxLength": 4 }, "codigoRazon3": { "type": "string", "maxLength": 4 }, "codigoRazon4": { "type": "string", "maxLength": 4 }, "errorScore": { "type": "string", "maxLength": 4 } } } }, {} ] }, "historiaConsultas": { "type": "array", "description": "Presents the details of the inquiries made to the record and is only shown if the value 007 was included in tag 00 of the EM segment in the inquiry string.", "items": { "type": "object", "properties": { "rfc": { "type": "string" }, "fechaConsulta": { "type": "string" }, "tipoUsuario": { "type": "string", "description": "Generic name that Buró de Crédito assigns to Grantors according to their industry or line of business." } } } } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "description": "Success response of bureau PM INTL service", "additionalProperties": true } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "429": { "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "content": { "application/json": { "schema": { "type": "object", "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "properties": { "id": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 429 ] }, "error": { "type": "string", "enum": [ "Too Many Requests" ] }, "message": { "type": "string", "enum": [ "Has excedido el limite de uso de cuenta de moffin. Escribe a soporte de moffin." ] } }, "additionalProperties": false } } } }, "500": { "description": "Error schema", "content": { "application/json": { "schema": { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } } } } } } } }, "/api/v1/query/sat_blacklist": { "post": { "tags": [ "Query data sources" ], "description": "Sat blacklist profile query", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "phone": { "type": "string", "PhoneValidator": { "allowNull": false } }, "rfc": { "type": "string" }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "maxLength": 18, "minLength": 18 }, "accountType": { "type": "string", "enum": [ "PM", "PF" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "differenceInYears": { "op": "gt", "value": "10" } }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } }, "required": [ "accountType", "rfc" ], "oneOf": [ { "type": "object", "title": "Persona moral", "properties": { "rfc": { "type": "string", "minLength": 12, "maxLength": 12, "RFCValidator": { "rfcType": "PM", "homoclave": { "enabled": true, "required": true } } } } }, { "type": "object", "title": "Persona física", "properties": { "rfc": { "type": "string", "minLength": 13, "maxLength": 13, "RFCValidator": { "rfcType": "PF", "homoclave": { "enabled": true, "required": true } } } } } ], "example": { "rfc": "BEAS50121757A", "accountType": "PF" } }, "example": { "rfc": "BEAS50121757A", "accountType": "PF" } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of sat blacklist service", "nullable": true, "additionalProperties": false, "properties": { "RFC": { "type": "string" }, "RazonSocial": { "type": "string" }, "Estatus": { "type": "string", "enum": [ "Desvirtuado", "Presunto", "Sentencia", "Favorable", "Definitivo" ] }, "NumOficioPresuntoSAT": { "type": "string", "description": "Numero del oficio presunto del SAT" }, "FechaOficioPresuntoSAT": { "type": "string", "description": "Fecha del oficio presunto del SAT" }, "NumOficioPresuntoDOF": { "type": "string", "description": "Numero del oficio presunto del Diario oficial de la federacion" }, "FechaOficioPresuntoDOF": { "type": "string", "description": "Fecha del oficio presunto del Diario oficial de la federacion" }, "NumOficioDesvirtuadoSAT": { "type": "string", "description": "Numero del oficio desvirtuado del SAT" }, "FechaOficioDesvirtuadoSAT": { "type": "string", "description": "Fecha del oficio desvirtuado del SAT" }, "FechaOficioDesvirtuadoDOF": { "type": "string", "description": "Fecha del oficio desvirtuado del Diario oficial de la federacion" }, "NumOficioDefinitivoSAT": { "type": "string", "description": "Numero del oficio definitivo del SAT" }, "FechaOficioDefinitivoSAT": { "type": "string", "description": "Fecha del oficio definitivo del SAT" }, "FechaOficioDefinitivoDOF": { "type": "string", "description": "Numero del oficio definitivo del Diario oficial de la federacion" }, "NumOficioSentenciaFavorableSAT": { "type": "string", "description": "Numero del oficio sentencia favorable del SAT" }, "FechaOficioSentenciaFavorableSAT": { "type": "string", "description": "Fecha del oficio sentencia favorable del SAT" }, "NumOficioSentenciaFavortableDOF": { "type": "string", "description": "Numero del oficio sentencia favorable del Diario oficial de la federacion" }, "FechaOficioSentenciaFavorableDOF": { "type": "string", "description": "Fecha del oficio sentencia favorable del Diario oficial de la federacion" } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "sat_1", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PM", "reportType": "sat_1", "query": { "rfc": "AAA080808HL8" } }, "query": { "rfc": "AAA080808HL8" }, "response": { "RFC": "AAA080808HL8", "RazonSocial": "ASESORES EN AVAL�OS Y ACTIVOS, S.A. DE C.V.", "Estatus": "Sentencia Favorable", "NumOficioPresuntoSAT": "500-05-2018-16632 de fecha 01 de junio de 2018", "FechaOficioPresuntoSAT": "2018-06-01", "NumOficioPresuntoDOF": "500-05-2018-16632 de fecha 01 de junio de 2018", "FechaOficioPresuntoDOF": "2018-06-25", "NumOficioDesvirtuadoSAT": "", "FechaOficioDesvirtuadoSAT": "", "FechaOficioDesvirtuadoDOF": "", "NumOficioDefinitivoSAT": "500-05-2018-27105 de fecha 27 de septiembre de 2018", "FechaOficioDefinitivoSAT": "2018-09-28", "FechaOficioDefinitivoDOF": "2018-10-23", "NumOficioSentenciaFavorableSAT": "500-05-2019-7305 de fecha 5 de marzo de 2019", "FechaOficioSentenciaFavorableSAT": "2019-03-05", "NumOficioSentenciaFavortableDOF": "500-05-2019-7305 de fecha 5 de marzo de 2019", "FechaOficioSentenciaFavorableDOF": "2019-04-16" }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T18:23:26.341Z", "updatedAt": "2023-07-05T18:23:26.357Z", "deletedAt": null, "cachedFrom": null } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "sat_1", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PM", "reportType": "sat_1", "query": { "rfc": "AAA080808HL8" } }, "query": { "rfc": "AAA080808HL8" }, "response": { "RFC": "AAA080808HL8", "RazonSocial": "ASESORES EN AVAL�OS Y ACTIVOS, S.A. DE C.V.", "Estatus": "Sentencia Favorable", "NumOficioPresuntoSAT": "500-05-2018-16632 de fecha 01 de junio de 2018", "FechaOficioPresuntoSAT": "2018-06-01", "NumOficioPresuntoDOF": "500-05-2018-16632 de fecha 01 de junio de 2018", "FechaOficioPresuntoDOF": "2018-06-25", "NumOficioDesvirtuadoSAT": "", "FechaOficioDesvirtuadoSAT": "", "FechaOficioDesvirtuadoDOF": "", "NumOficioDefinitivoSAT": "500-05-2018-27105 de fecha 27 de septiembre de 2018", "FechaOficioDefinitivoSAT": "2018-09-28", "FechaOficioDefinitivoDOF": "2018-10-23", "NumOficioSentenciaFavorableSAT": "500-05-2019-7305 de fecha 5 de marzo de 2019", "FechaOficioSentenciaFavorableSAT": "2019-03-05", "NumOficioSentenciaFavortableDOF": "500-05-2019-7305 de fecha 5 de marzo de 2019", "FechaOficioSentenciaFavorableDOF": "2019-04-16" }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T18:23:26.341Z", "updatedAt": "2023-07-05T18:23:26.357Z", "deletedAt": null, "cachedFrom": null } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } } } } }, "/api/v1/query/sat_rfc": { "post": { "summary": "SAT RFC Certificates query", "tags": [ "Query data sources" ], "description": "Sat rfc certificates profile query. This is an asynchronous query, responses are returned using weebhooks. Make sure you have Webhooks configured correctly in your Moffin account.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "phone": { "type": "string", "PhoneValidator": { "allowNull": false } }, "rfc": { "type": "string" }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "maxLength": 18, "minLength": 18 }, "accountType": { "type": "string", "enum": [ "PM", "PF" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "differenceInYears": { "op": "gt", "value": "10" } }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } }, "required": [ "accountType", "rfc" ], "oneOf": [ { "type": "object", "title": "Persona moral", "properties": { "rfc": { "type": "string", "minLength": 12, "maxLength": 12, "RFCValidator": { "rfcType": "PM", "homoclave": { "enabled": true, "required": true } } } } }, { "type": "object", "title": "Persona física", "properties": { "rfc": { "type": "string", "minLength": 13, "maxLength": 13, "RFCValidator": { "rfcType": "PF", "homoclave": { "enabled": true, "required": true } } } } } ], "example": { "rfc": "BEAS50121757A", "accountType": "PF" } }, "example": { "rfc": "BEAS50121757A", "accountType": "PF" } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of SAT Certificates service", "nullable": true, "additionalProperties": false, "properties": { "type": { "type": "string" }, "success": { "type": "boolean" }, "exists": { "type": "boolean" }, "data": { "type": "object", "nullable": true, "properties": { "tradeName": { "type": "string" }, "certificates": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string" }, "state": { "type": "string" }, "type": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "userData": { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string" }, "curp": { "type": "string" }, "counselCurp": { "type": "string", "nullable": true }, "name": { "type": "string" }, "orgName": { "type": "string" }, "country": { "type": "string" }, "fullname": { "type": "string" }, "rfc": { "type": "string" }, "counselRfc": { "type": "string", "nullable": true } } } } } } } }, "captchaAttempts": { "type": "number", "nullable": true } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "sat_rfc", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PM", "reportType": "sat_rfc", "query": { "rfc": "AGS930324RN7", "profileId": 1 } }, "query": { "rfc": "AGS930324RN7" }, "response": { "success": true, "exists": true, "data": { "tradeName": "ALMACENES GHINO S SA DE CV", "certificates": [ { "url": "https://example@example.com", "state": "Revocado", "type": "SELLO", "startDate": "2014-01-27 16:50:04", "endDate": "2017-07-03 21:32:23" }, { "url": "https://example@example.com", "state": "Caduco", "type": "FIEL", "startDate": "2014-01-27 14:27:01", "endDate": "2018-01-27 14:27:41", "userData": { "email": "example@example.com", "curp": "", "counselCurp": "XXXX410215XXXXXX08", "name": "ALMACENES GHINO S SA DE CV", "orgName": "ALMACENES GHINO S SA DE CV", "country": "MX", "fullname": "CN=ALMACENES GHINO S SA DE CV, 2.5.4.41=ALMACENES GHINO S SA DE CV, O=ALMACENES GHINO S SA DE CV, C=MX, 1.2.840.113549.1.9.1=example@example.com, 2.5.4.45=AGS930324RN7 / XXXX410215XX2, SN= / XXXX410215XXXXXX08", "rfc": "AGS930324RN7", "counselRfc": "XXXX410215XX2" } }, { "url": "https://example@example.com", "state": "Caduco", "type": "FIEL", "startDate": "2010-12-15 17:33:51", "endDate": "2013-03-14 17:33:51", "userData": { "email": "", "curp": "", "counselCurp": "XXXX410215XXXXXX08", "name": "ALMACENES GHINO S SA DE CV", "orgName": "ALMACENES GHINO S SA DE CV", "country": "MX", "fullname": "CN=ALMACENES GHINO S SA DE CV, 2.5.4.41=ALMACENES GHINO S SA DE CV, O=ALMACENES GHINO S SA DE CV, C=MX, 1.2.840.113549.1.9.1=example@example.com, 2.5.4.45=AGS930324RN7 / XXXX410215XX2, SN= / XXXX410215XXXXXX08", "rfc": "AGS930324RN7", "counselRfc": "XXXX410215XX2" } }, { "url": "https://example@example.com", "state": "Revocado", "type": "FIEL", "startDate": "2009-01-14 16:56:19", "endDate": "2010-12-15 17:33:52" }, { "url": "https://example@example.com", "state": "Caduco", "type": "FIEL", "startDate": "2005-07-28 16:58:20", "endDate": "2007-07-28 16:58:20" } ] } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T18:29:12.521Z", "updatedAt": "2023-07-05T18:29:35.784Z", "deletedAt": null, "cachedFrom": null } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "sat_rfc", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PM", "reportType": "sat_rfc", "query": { "rfc": "AGS930324RN7", "profileId": 1 } }, "query": { "rfc": "AGS930324RN7" }, "response": { "success": true, "exists": true, "data": { "tradeName": "ALMACENES GHINO S SA DE CV", "certificates": [ { "url": "https://example@example.com", "state": "Revocado", "type": "SELLO", "startDate": "2014-01-27 16:50:04", "endDate": "2017-07-03 21:32:23" }, { "url": "https://example@example.com", "state": "Caduco", "type": "FIEL", "startDate": "2014-01-27 14:27:01", "endDate": "2018-01-27 14:27:41", "userData": { "email": "example@example.com", "curp": "", "counselCurp": "XXXX410215XXXXXX08", "name": "ALMACENES GHINO S SA DE CV", "orgName": "ALMACENES GHINO S SA DE CV", "country": "MX", "fullname": "CN=ALMACENES GHINO S SA DE CV, 2.5.4.41=ALMACENES GHINO S SA DE CV, O=ALMACENES GHINO S SA DE CV, C=MX, 1.2.840.113549.1.9.1=example@example.com, 2.5.4.45=AGS930324RN7 / XXXX410215XX2, SN= / XXXX410215XXXXXX08", "rfc": "AGS930324RN7", "counselRfc": "XXXX410215XX2" } }, { "url": "https://example@example.com", "state": "Caduco", "type": "FIEL", "startDate": "2010-12-15 17:33:51", "endDate": "2013-03-14 17:33:51", "userData": { "email": "", "curp": "", "counselCurp": "XXXX410215XXXXXX08", "name": "ALMACENES GHINO S SA DE CV", "orgName": "ALMACENES GHINO S SA DE CV", "country": "MX", "fullname": "CN=ALMACENES GHINO S SA DE CV, 2.5.4.41=ALMACENES GHINO S SA DE CV, O=ALMACENES GHINO S SA DE CV, C=MX, 1.2.840.113549.1.9.1=example@example.com, 2.5.4.45=AGS930324RN7 / XXXX410215XX2, SN= / XXXX410215XXXXXX08", "rfc": "AGS930324RN7", "counselRfc": "XXXX410215XX2" } }, { "url": "https://example@example.com", "state": "Revocado", "type": "FIEL", "startDate": "2009-01-14 16:56:19", "endDate": "2010-12-15 17:33:52" }, { "url": "https://example@example.com", "state": "Caduco", "type": "FIEL", "startDate": "2005-07-28 16:58:20", "endDate": "2007-07-28 16:58:20" } ] } }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T18:29:12.521Z", "updatedAt": "2023-07-05T18:29:35.784Z", "deletedAt": null, "cachedFrom": null } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } } } } }, "/api/v1/query/renapo_curp": { "post": { "tags": [ "Query data sources" ], "description": "RENAPO CURP query", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "phone": { "type": "string", "PhoneValidator": { "allowNull": false } }, "rfc": { "type": "string", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": false } } }, "curp": { "type": "string", "minLength": 18, "maxLength": 18 }, "accountType": { "type": "string", "enum": [ "PM", "PF" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "differenceInYears": { "op": "gt", "value": "10" } }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } }, "required": [ "accountType", "curp" ] } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of SAT RENAPO", "nullable": true, "additionalProperties": false, "properties": { "estatus": { "type": "string", "enum": [ "OK" ] }, "codigoValidacion": { "type": "string" }, "curp": { "type": "string" }, "nombre": { "type": "string" }, "apellidoPaterno": { "type": "string" }, "apellidoMaterno": { "type": "string" }, "sexo": { "type": "string" }, "fechaNacimiento": { "type": "string" }, "paisNacimiento": { "type": "string" }, "estadoNacimiento": { "type": "string" }, "docProbatorio": { "type": "number" }, "datosDocProbatorio": { "entidadRegistro": { "type": "string" }, "tomo": { "type": "string" }, "claveMunicipioRegistro": { "type": "string" }, "anioReg": { "type": "string" }, "claveEntidadRegistro": { "type": "string" }, "foja": { "type": "string" }, "numActa": { "type": "string" }, "libro": { "type": "string" }, "municipioRegistro": { "type": "string" } }, "estatusCurp": { "type": "string", "enum": [ "AN", "AH", "RCC", "RCN", "BAP", "BSU", "BD", "BDM", "BDP", "BJD" ], "description": "

Active:

AN – Normal registration

AH – Registration with homonymy

RCC – Registration change affecting CURP

RCN – Registration change not affecting CURP

Not active:

BAP – Unsubscribed because apocryphal document

BSU – Unsubscribed without use

BD – Unsubscribed because of deceased

BDM – Administrative unsubscription

BDP – Unsubscribed because of adoption

BJD – Judicial unsubscription

" }, "codigoMensaje": { "type": "string" } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "renapo_curp", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PF", "reportType": "renapo_curp", "query": { "curp": "PETJ970221XXXXXX00" } }, "query": { "curp": "PETJ970221XXXXXX00" }, "response": { "estatus": "OK", "codigoValidacion": "xx0000000000.0000000", "curp": "PETJ970221XXXXXX00", "nombre": "JUAN JOSE", "apellidoPaterno": "TORRES", "apellidoMaterno": "LOPEZ", "sexo": "HOMBRE", "fechaNacimiento": "21/02/1997", "paisNacimiento": "MEXICO", "estadoNacimiento": "JALISCO", "docProbatorio": 1, "datosDocProbatorio": { "anioReg": "1997", "foja": "", "tomo": "", "libro": "", "numActa": "00000", "claveEntidadRegistro": "14", "entidadRegistro": "JALISCO", "claveMunicipioRegistro": "097", "municipioRegistro": "TONALA" }, "estatusCurp": "RCN", "codigoMensaje": "0" }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T18:38:33.643Z", "updatedAt": "2023-07-05T18:38:33.650Z", "deletedAt": null, "cachedFrom": null } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "renapo_curp", "status": "SUCCESS", "state": null, "metadata": { "clientType": "PF", "reportType": "renapo_curp", "query": { "curp": "PETJ970221XXXXXX00" } }, "query": { "curp": "PETJ970221XXXXXX00" }, "response": { "estatus": "OK", "codigoValidacion": "xx0000000000.0000000", "curp": "PETJ970221XXXXXX00", "nombre": "JUAN JOSE", "apellidoPaterno": "TORRES", "apellidoMaterno": "LOPEZ", "sexo": "HOMBRE", "fechaNacimiento": "21/02/1997", "paisNacimiento": "MEXICO", "estadoNacimiento": "JALISCO", "docProbatorio": 1, "datosDocProbatorio": { "anioReg": "1997", "foja": "", "tomo": "", "libro": "", "numActa": "00000", "claveEntidadRegistro": "14", "entidadRegistro": "JALISCO", "claveMunicipioRegistro": "097", "municipioRegistro": "TONALA" }, "estatusCurp": "RCN", "codigoMensaje": "0" }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T18:38:33.643Z", "updatedAt": "2023-07-05T18:38:33.650Z", "deletedAt": null, "cachedFrom": null } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } } } } }, "/api/v1/query/id_validation/jumio": { "post": { "tags": [ "Query data sources" ], "description": "Create JUMIO KYC link", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "successURL": { "type": "string" }, "failURL": { "type": "string" }, "profileId": { "type": "string", "description": "Id related to user profile, send this field or `externalId` but not both" }, "externalId": { "type": "string", "description": "externalId related to user profile, send this field or `profileId` but not both" }, "metadata": { "default": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } } }, "additionalProperties": false } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "nullable": true, "additionalProperties": false, "properties": { "id": { "type": "string" }, "formURL": { "type": "string" }, "formURLExpiresAt": { "type": "string" }, "flow": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "startedAt": { "type": "string" }, "completedAt": { "type": "string" }, "decision": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NOT_EXECUTED", "PASSED", "REJECTED", "WARNING" ] }, "details": { "type": "object", "properties": { "label": { "type": "string", "enum": [ "NOT_EXECUTED", "PASSED", "REJECTED", "TECHNICAL_ERROR", "WARNING" ] } } }, "risk": { "type": "object", "properties": { "score": { "type": "number" } } } } }, "extraction": { "type": "object", "nullable": true, "properties": { "decision": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NOT_EXECUTED", "PASSED" ] }, "details": { "type": "object", "properties": { "label": { "type": "string", "enum": [ "PRECONDITION_NOT_FULFILLED", "TECHNICAL_ERROR", "OK" ] } } } } }, "type": { "type": "string", "enum": [ "PASSPORT", "DRIVING_LICENSE", "ID_CARD", "VISA", "UNSUPPORTED" ] }, "subType": { "type": "string", "enum": [ "NATIONAL_ID", "CONSULAR_ID", "ELECTORAL_ID", "RESIDENT_PERMIT_ID", "TAX_ID", "STUDENT_ID", "PASSPORT_CARD_ID", "MILITARY_ID", "PUBLIC_SAFETY_ID", "HEALTH_ID", "OTHER_ID", "VISA", "UNKNOWN", "REGULAR_DRIVING_LICENSE", "LEARNING_DRIVING_LICENSE", "E_PASSPORT" ] }, "issuingCountry": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthdate": { "type": "string" }, "placeOfBirth": { "type": "string" }, "taxNumber": { "type": "string" }, "registrationNumber": { "type": "string" }, "personalIdentificationNumber": { "type": "string" }, "fathersName": { "type": "string" }, "mothersName": { "type": "string" }, "expiryDate": { "type": "string" }, "issuingDate": { "type": "string" }, "issuingAuthority": { "type": "string" }, "issuingPlace": { "type": "string" }, "gender": { "type": "string", "enum": [ "M", "F", "X" ] }, "personalNumber": { "type": "string" }, "documentNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "zipCode": { "type": "string" }, "subdivision": { "type": "string" }, "city": { "type": "string" }, "formattedAddress": { "type": "string" } } }, "currentAge": { "type": "string" }, "curp": { "type": "string" }, "nationality": { "type": "string" }, "voterIdNumber": { "type": "string" }, "issuingNumber": { "type": "string" }, "passportNumber": { "type": "string" }, "durationOfStay": { "type": "string" }, "numberOfEntries": { "type": "string" }, "visaCategory": { "type": "string" }, "dni": { "type": "string" }, "laborIdentificationNumber": { "type": "string" }, "documentIdentificationNumber": { "type": "string" }, "driverLicenceCategories": { "type": "array", "items": { "type": "string" } } } }, "similarity": { "type": "object", "description": "This property can be null if the flow is 10015", "nullable": true, "properties": { "match": { "type": "boolean" } } }, "liveness": { "type": "object", "description": "This property can be null if the flow is 10015", "nullable": true, "properties": { "isOk": { "type": "boolean" } } }, "photos": { "type": "object", "nullable": true, "properties": { "documents": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PASSPORT", "DRIVING_LICENSE", "ID_CARD", "VISA", "UNSUPPORTED" ] }, "nullable": true } }, "front": { "type": "string", "nullable": true }, "back": { "type": "string", "nullable": true }, "selfie": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } } }, "facemap": { "type": "array", "nullable": true, "items": { "frame": { "type": "number" }, "url": { "type": "string" } } } } } } }, "message": { "type": "string" } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "example": { "id": 1, "authentication": "CUSTOM", "service": "jumio_id_validation", "status": "PENDING", "state": null, "metadata": { "clientType": "PF", "reportType": "PF", "query": { "failURL": "https://moffin.mx", "successURL": "https://moffin.mx" } }, "query": { "successURL": "https://moffin.mx", "failURL": "https://moffin.mx" }, "response": { "id": "11111111-2249-4f1e-a19d-a34dd08611de", "formURL": "https://example.com", "formURLExpiresAt": "2023-07-06T19:40:21.907Z" }, "requesterId": 1, "organizationId": 1, "profileId": null, "formId": null, "externalId": null, "createdAt": "2023-07-05T19:40:21.897Z", "updatedAt": "2023-07-05T19:40:21.908Z", "deletedAt": null, "cachedFrom": null } }, "example": { "id": 1, "authentication": "CUSTOM", "service": "jumio_id_validation", "status": "PENDING", "state": null, "metadata": { "clientType": "PF", "reportType": "PF", "query": { "failURL": "https://moffin.mx", "successURL": "https://moffin.mx" } }, "query": { "successURL": "https://moffin.mx", "failURL": "https://moffin.mx" }, "response": { "id": "11111111-2249-4f1e-a19d-a34dd08611de", "formURL": "https://example.com", "formURLExpiresAt": "2023-07-06T19:40:21.907Z" }, "requesterId": 1, "organizationId": 1, "profileId": null, "formId": null, "externalId": null, "createdAt": "2023-07-05T19:40:21.897Z", "updatedAt": "2023-07-05T19:40:21.908Z", "deletedAt": null, "cachedFrom": null } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "401": { "description": "Unauthorized response", "content": { "application/json": { "schema": { "type": "object", "description": "Unauthorized response", "properties": { "statusCode": { "type": "number", "enum": [ 401 ] }, "error": { "type": "string", "enum": [ "Unauthorized" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "403": { "description": "Forbidden response", "content": { "application/json": { "schema": { "type": "object", "description": "Forbidden response", "properties": { "statusCode": { "type": "number", "enum": [ 403 ] }, "error": { "type": "string", "enum": [ "Forbidden" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } } } } }, "/api/v1/query/imss-job-history": { "post": { "summary": "Get IMSS Job History", "tags": [ "Query data sources" ], "description": "Get IMSS Job History

This endpoint will return a pending response. The complete response will be returned shortly afterwards as a webhook response (imss_job_history).

Guide: https://guides.moffin.mx/imss-historial-de-trabajo

", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "curp": { "type": "string", "maxLength": 18, "minLength": 18 }, "externalId": { "type": "string", "nullable": true, "maxLength": 256 }, "metadata": { "default": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } } }, "required": [ "curp" ], "additionalProperties": false, "example": { "curp": "ROGE820204MTSDRR08" } }, "example": { "curp": "ROGE820204MTSDRR08" } } }, "required": true }, "deprecated": true, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of pending IMSS report", "nullable": true, "additionalProperties": false, "properties": { "name": { "type": "string", "nullable": true }, "nss": { "type": "string", "nullable": true }, "curp": { "type": "string" }, "paymentsToIMSS": { "type": "object", "nullable": true, "properties": { "success": { "type": "number" }, "reinstated": { "type": "number" }, "discounted": { "type": "number" } } }, "jobs": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "terminationDate": { "type": "string" }, "startDate": { "type": "string" }, "income": { "type": "number" }, "federalEntity": { "type": "string" }, "contractor": { "type": "string" }, "contractorId": { "type": "string" } } } }, "message": { "type": "string" } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "imss_job_history", "status": "PENDING", "state": null, "metadata": { "clientType": "PF", "reportType": "PF", "query": { "curp": "XXXX021113XXXXXXX3" } }, "query": { "curp": "XXXX021113XXXXXXX3" }, "response": { "name": null, "nss": null, "curp": "XXXX021113XXXXXXX3", "paymentsToIMSS": null, "jobs": null }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T19:13:27.876Z", "updatedAt": "2023-07-05T19:13:27.896Z", "deletedAt": null, "cachedFrom": null } }, "example": { "id": 1, "authentication": "MOFFIN", "service": "imss_job_history", "status": "PENDING", "state": null, "metadata": { "clientType": "PF", "reportType": "PF", "query": { "curp": "XXXX021113XXXXXXX3" } }, "query": { "curp": "XXXX021113XXXXXXX3" }, "response": { "name": null, "nss": null, "curp": "XXXX021113XXXXXXX3", "paymentsToIMSS": null, "jobs": null }, "requesterId": 1, "organizationId": 1, "profileId": 1, "formId": null, "externalId": null, "createdAt": "2023-07-05T19:13:27.876Z", "updatedAt": "2023-07-05T19:13:27.896Z", "deletedAt": null, "cachedFrom": null } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } } } } }, "/api/v1/query/ca-blacklist": { "post": { "summary": "Get Comply Advantage Blacklist", "tags": [ "Query data sources" ], "description": "Get Comply Advantage Blacklist", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 256 }, "middleName": { "type": "string", "maxLength": 256 }, "firstLastName": { "type": "string", "maxLength": 256 }, "secondLastName": { "type": "string", "maxLength": 256 }, "tradeName": { "type": "string", "maxLength": 256 }, "externalId": { "type": "string", "maxLength": 256 }, "accountType": { "type": "string", "enum": [ "PF", "PM" ] }, "filters": { "type": "object", "properties": { "birthYear": { "type": "string", "pattern": "^[0-9]{4}$" }, "removeDeceased": { "type": "integer", "enum": [ 0, 1 ] }, "exactMatch": { "type": "boolean" }, "countryCodes": { "type": "array", "items": { "type": "string" } }, "entityType": { "type": "string", "enum": [ "person", "company", "organisation", "aircraft", "vessel" ] } } }, "metadata": { "default": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } } }, "required": [ "accountType" ], "additionalProperties": false }, "examples": { "Carlos Moffin": { "value": { "firstName": "Carlos", "firstLastName": "Moffin", "accountType": "PF" } }, "Bad Organizatio": { "value": { "tradeName": "Bad Organization", "accountType": "PM" } }, "no match": { "value": { "tradeName": "no match", "accountType": "PM" } } } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "description": "Response of Comply Advantage Blacklist report", "nullable": true, "additionalProperties": false, "properties": { "searchTerm": { "type": "string" }, "searchId": { "type": "string" }, "matchStatus": { "type": "string" }, "monitorStatus": { "type": "string" }, "riskLevel": { "type": "string" }, "resultsFound": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "title": { "type": "string" }, "lastUpdatedUtc": { "type": "string" }, "associates": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "name": { "type": "string" }, "association": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true } } } }, "fields": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "tag": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true } } } }, "media": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "snippet": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } } }, "matched": { "type": "array", "nullable": true, "items": { "type": "string" } }, "score": { "type": "number" }, "sources": { "type": "array", "nullable": true, "items": { "type": "string" } }, "type": { "type": "string" }, "matchTypes": { "type": "array", "nullable": true, "items": { "type": "string" } }, "matchTypesDetails": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "aml_types": { "type": "array", "items": { "type": "string" } }, "secondary_matches": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "query_term": { "type": "string", "nullable": true }, "match_types": { "type": "array", "nullable": true, "items": { "type": "string" } } } } } } } } } } }, "totalHits": { "type": "number" }, "totalMatches": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } }, "examples": { "Carlos Moffin": { "value": { "id": 44, "uuid": "cb2b266b-a4e6-4760-8b70-ce58d15e968f", "authentication": "CUSTOM", "service": "ca_blacklist", "status": "SUCCESS", "state": {}, "metadata": { "clientType": "PF", "reportType": "PF", "query": { "searchTerm": "Carlos Moffin ", "accountType": "PF" } }, "query": { "searchTerm": "Carlos Moffin ", "accountType": "PF" }, "response": { "searchTerm": "Carlos Moffin ", "searchId": "1312796095", "matchStatus": "potential_match", "riskLevel": "unknown", "resultsFound": [ { "title": "Carlos Moffin", "matched": [ "sanction" ], "score": 3.511, "sources": [ "swiss-seco-list" ], "type": "person" } ], "totalHits": 1, "totalMatches": 1, "createdAt": "2023-08-07T02:40:49.210Z", "updatedAt": "2023-08-07T02:40:49.210Z" }, "requesterId": 1001, "organizationId": 1, "profileId": 24, "formId": null, "externalId": null, "createdAt": "2023-08-07T02:40:49.211Z", "updatedAt": "2023-08-07T02:40:49.213Z", "deletedAt": null, "cachedFrom": null } }, "Bad Organization": { "value": { "id": 45, "uuid": "1d6ad0ac-5aaa-42b4-864c-2fbca835e80f", "authentication": "CUSTOM", "service": "ca_blacklist", "status": "SUCCESS", "state": {}, "metadata": { "clientType": "PM", "reportType": "PM", "query": { "searchTerm": "Bad Organization", "accountType": "PM" } }, "query": { "searchTerm": "Bad Organization", "accountType": "PM" }, "response": { "searchTerm": "Bad Organization", "searchId": "1312796095", "matchStatus": "potential_match", "riskLevel": "unknown", "resultsFound": [ { "title": "Bad Organization", "matched": [ "warning" ], "score": 0.7, "sources": [ "russian-federation-ministry-of-justice-list-of-undesirable-foreign-and-international-non-governmental-organizations" ], "type": "organisation" } ], "totalHits": 1, "totalMatches": 1, "createdAt": "2023-08-07T02:41:22.071Z", "updatedAt": "2023-08-07T02:41:22.071Z" }, "requesterId": 1001, "organizationId": 1, "profileId": 25, "formId": null, "externalId": null, "createdAt": "2023-08-07T02:41:22.072Z", "updatedAt": "2023-08-07T02:41:22.075Z", "deletedAt": null, "cachedFrom": null } }, "no match": { "value": { "id": 42, "uuid": "2263493c-3b4b-4239-b952-e947cb80091e", "authentication": "CUSTOM", "service": "ca_blacklist", "status": "SUCCESS", "state": {}, "metadata": { "clientType": "PM", "reportType": "PM", "query": { "searchTerm": "no match", "accountType": "PM" } }, "query": { "searchTerm": "no match", "accountType": "PM" }, "response": { "searchTerm": "no match", "searchId": "1312796095", "matchStatus": "no_match", "riskLevel": "unknown", "resultsFound": [], "totalHits": 0, "totalMatches": 0, "createdAt": "2023-08-07T02:39:18.562Z", "updatedAt": "2023-08-07T02:39:18.562Z" }, "requesterId": 1001, "organizationId": 1, "profileId": 22, "formId": null, "externalId": null, "createdAt": "2023-08-07T02:39:18.563Z", "updatedAt": "2023-08-07T02:39:18.567Z", "deletedAt": null, "cachedFrom": null } } } } } } } } }, "/api/v1/query/circulo_credito_pf": { "post": { "summary": "Circulo de Crédito - Persona Física", "tags": [ "Query data sources" ], "description": "Reporte Consolidado V2 con Score", "requestBody": { "content": { "application/json": { "schema": { "title": "Persona Física", "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string" }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "phone": { "type": "string", "PhoneValidator": { "allowNull": false } }, "rfc": { "RFCValidator": { "rfcType": "PF", "homoclave": { "enabled": true, "required": false } } }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "maxLength": 18, "minLength": 18 }, "accountType": { "type": "string", "enum": [ "PF" ] }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "neighborhood": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "city": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "municipality": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-\\s,()/]*$" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix). https://www.iso.org/obp/ui/#iso:code:3166:MX" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx", "ZipCodeMatchState": true }, "exteriorNumber": { "type": "string", "maxLength": 256, "nullable": true, "default": null }, "interiorNumber": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nationality": { "type": "string", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "default": "MX" }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "differenceInYears": { "op": "gt", "value": "10" } }, "metadata": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } } } }, "anyOf": [ { "type": "object", "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"" } } }, { "type": "object", "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\"" } } } ], "additionalProperties": false, "required": [ "firstLastName", "secondLastName", "firstName", "birthdate", "rfc", "nationality", "address", "neighborhood", "municipality", "city", "state", "zipCode" ] } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": false, "properties": { "folioConsulta": { "type": "string" }, "consultas": { "type": "array", "items": { "type": "object", "properties": { "fechaConsulta": { "type": "string", "format": "date" }, "claveOtorgante": { "type": "string", "minLength": 0, "maxLength": 10 }, "nombreOtorgante": { "type": "string", "minLength": 0, "maxLength": 40 }, "direccionOtorgante": { "type": "string", "minLength": 0, "maxLength": 80 }, "telefonoOtorgante": { "type": "string", "minLength": 0, "maxLength": 20 }, "tipoCredito": { "type": "string" }, "importeCredito": { "type": "number" }, "tipoResponsabilidad": { "type": "string", "description": "
ClaveTipo de responsabilidad
IIndividual(Titular)
MMancomunado
OObligatorio Solidario
AAval
TTitular con Aval
", "enum": [ "I", "M", "O", "A", "T" ] }, "claveUnidadMonetaria": { "type": "string", "description": "MX: Pesos Mexicanos, US: Dólares, UD: Unidades de inversión", "enum": [ "MX", "US", "UD" ] }, "idDomicilio": { "type": "string", "minLength": 0, "maxLength": 20 }, "servicios": { "type": "string", "description": "0: Sin servicios, 1: Servicios al hogar", "enum": [ "0", "1" ] } } } }, "creditos": { "type": "array", "items": { "type": "object", "properties": { "fechaActualizacion": { "type": "string", "format": "date" }, "registroImpugnado": { "type": "string" }, "claveOtorgante": { "type": "string", "minLength": 0, "maxLength": 10 }, "nombreOtorgante": { "type": "string", "minLength": 0, "maxLength": 40 }, "cuentaActual": { "type": "string", "minLength": 0, "maxLength": 25 }, "tipoResponsabilidad": { "type": "string", "description": "
ClaveTipo de responsabilidad
IIndividual(Titular)
MMancomunado
OObligatorio Solidario
AAval
TTitular con Aval
", "enum": [ "I", "M", "O", "A", "T" ] }, "tipoCuenta": { "type": "string", "description": "
ClaveTipo de cuenta
FPagos fijos
HHipoteca
LSin límite preestablecido
RRevolvente
QQuirografario
ACrédito de habilitación o avío
ECrédito refaccionario
PCrédito prendario
", "enum": [ "F", "H", "L", "R", "Q", "A", "E", "P" ] }, "tipoCredito": { "type": "string", "description": "
ClaveTipo de Contrato
AAArrendamiento Automotriz
ABAutomotriz Bancario
AEFísica Actividad Empresarial
AMAparatos/Muebles
ARArrendamiento
AVAviación
BCBanca Comunal
BLBote/Lancha
BRBienes Raíces
CACompra De Automóvil
CCCrédito Al Consumo
CFCrédito Fiscal
COConsolidación
CPCrédito Personal Al Consumo
EDEditorial
EQEquipo
FFFondeo Fira
FIFianza
FTFactoraje
GSGrupo Solidario
HBHipotecario Bancario
HEPréstamo Tipo Home Equity
HVHipotecario ó Vivienda
LCLínea de Crédito
MCMejoras a la Casa
NGPréstamo No Garantizado
PBPréstamo Personal Bancario
PCProcampo
PEPréstamo Para Estudiante
PGPréstamo Garantizado
PQPréstamo Quirografario
PMPréstamo Empresarial
PNPréstamo de Nómina
PPPréstamo Personal
SHSegunda Hipoteca
TCTarjeta De Crédito
TDTarjeta Departamental
TGTarjeta Garantizada
TSTarjeta De Servicios
VRVehículo Recreativo
OTOtros
NCDesconocido
", "enum": [ "AA", "AB", "AE", "AM", "AR", "AV", "BC", "BL", "BR", "CA", "CC", "CF", "CO", "CP", "ED", "EQ", "FF", "FI", "FT", "GS", "HB", "HE", "HV", "LC", "MC", "NG", "PB", "PC", "PE", "PG", "PQ", "PM", "PN", "PP", "SH", "TC", "TD", "TG", "TS", "VR", "OT", "NC" ] }, "claveUnidadMonetaria": { "type": "string", "description": "MX: Pesos Mexicanos, US: Dólares, UD: Unidades de inversión", "enum": [ "MX", "US", "UD" ] }, "valorActivoValuacion": { "type": "string" }, "numeroPagos": { "type": "integer" }, "frecuenciaPagos": { "type": "string", "description": "
ValorDescripción
AAnual
BBimestral
CCatorcenal
DDeducción del Salario
ESemestral
MMensual
QQuincenal
RPago Mínimo Para Cuentas Revolventes
SSemanal
TTrimestral
UUna Sola Exhibición
", "enum": [ "A", "B", "C", "D", "E", "M", "Q", "R", "S", "T", "U" ] }, "montoPagar": { "type": "number" }, "fechaAperturaCuenta": { "type": "string", "format": "date" }, "fechaUltimoPago": { "type": "string", "format": "date" }, "fechaUltimaCompra": { "type": "string", "format": "date" }, "fechaCierreCuenta": { "type": "string", "format": "date" }, "fechaReporte": { "type": "string", "format": "date" }, "ultimaFechaSaldoCero": { "type": "string", "format": "date" }, "garantia": { "type": "string" }, "creditoMaximo": { "type": "number" }, "saldoActual": { "type": "number" }, "limiteCredito": { "type": "number" }, "saldoVencido": { "type": "number" }, "numeroPagosVencidos": { "type": "integer" }, "pagoActual": { "type": "string" }, "historicoPagos": { "type": "string" }, "fechaRecienteHistoricoPagos": { "type": "string", "format": "date" }, "fechaAntiguaHistoricoPagos": { "type": "string", "format": "date" }, "clavePrevencion": { "type": "string", "description": "
ClaveDescripción
ADCuenta o monto en aclaración
CACartera al Corriente Vendida o cedida a un usuario de una Sociedad
CCCuenta cancelada o cerrada
CDConvenio y disminución de pago
CLCuenta cerrada que estuvo en cobranza y fue pagada totalmente sin causar quebranto
COCrédito en Controversia
CVCuenta que no está al corriente vendida o cedida a un usuario de una Sociedad
FDCuenta Fraudulenta
FNFraude no Atribuible al Consumidor
FPFianza pagada
FRAdjudicación o aplicación de garantía
GPEjecución de Garantía Prendaria o Fiduciaria en Pago por Crédito
IACuenta Inactiva
IMIntegrante causante de mora
ISIntegrante que fue subsidiado para evitar mora
LCConvenio de finiquito o pago menor acordado con el Consumidor
LGPago menor por programa institucional o de gobierno, incluyendo los apoyos a damnificados por catástrofes naturales
LOEn Localización
LSTarjeta de Crédito Extraviada o Robada
NACuenta al corriente vendida o cedida a un NO Usuario de una Sociedad
NVCuenta que no está al corriente vendida o cedida a un NO Usuario de una Sociedad
PCCuenta en Cobranza
PDPrórroga otorgada debido a un desastre natural
PEPrórroga otorgada al acreditado por situaciones especiales
PIPrórroga otorgada al acreditado por invalidez, defunción
PRPrórroga otorgada debido a una pérdida de relación laboral
RACuenta reestructurada sin pago menor, por programa institucional o gubernamental, incluyendo los apoyos a damnificados por catástrofes naturales
RIRobo de identidad
RFResolución judicial favorable al cliente
RNCuenta reestructurada debido a un proceso judicial
RVCuenta reestructurada sin pago menor por modificación de la situación del cliente, a petición de éste
SGDemanda por el Otorgante
UPCuenta que causa quebranto
VRDación en Pagos ó Renta
", "enum": [ "AD", "CA", "CC", "CD", "CL", "CO", "CV", "FD", "FN", "FP", "FR", "GP", "IA", "IM", "IS", "LC", "LG", "LO", "LS", "NA", "NV", "PC", "PD", "PE", "PI", "PR", "RA", "RI", "RF", "RN", "RV", "SG", "UP", "VR" ] }, "totalPagosReportados": { "type": "integer" }, "peorAtraso": { "type": "number" }, "fechaPeorAtraso": { "type": "string", "format": "date" }, "saldoVencidoPeorAtraso": { "type": "number" }, "montoUltimoPago": { "type": "number" }, "idDomicilio": { "type": "string" }, "servicios": { "type": "string", "description": "0: Sin servicios, 1: Servicios al hogar", "enum": [ "0", "1" ] } } } }, "domicilios": { "type": "array", "items": { "type": "object", "properties": { "direccion": { "type": "string", "minLength": 0, "maxLength": 85 }, "colonia": { "type": "string", "minLength": 0, "maxLength": 65 }, "municipio": { "type": "string", "minLength": 0, "maxLength": 65 }, "ciudad": { "type": "string", "minLength": 0, "maxLength": 65 }, "estado": { "type": "string", "enum": [ "AGS", "BC", "BCS", "CAMP", "CHIS", "CHIH", "COAH", "COL", "CDMX", "DGO", "GTO", "GRO", "HGO", "JAL", "MEX", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QROO", "SLP", "SIN", "SON", "TAB", "TAMP", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "pattern": "^\\d*$", "minLength": 0, "maxLength": 5 }, "fechaResidencia": { "type": "string", "format": "date" }, "numeroTelefono": { "type": "string", "minLength": 0, "maxLength": 20 }, "tipoDomicilio": { "type": "string", "enum": [ "N", "O", "C", "P", "E" ] }, "tipoAsentamiento": { "type": "string", "description": "
ClaveTipo de Asentamiento
0PENDIENTE POR ACTUALIZAR
1AEROPUERTO
2BARRIO
3BASE NAVAL
4CAMPAMENTO
5CENTRO
6CENTRO URBANO
7COLONIA
8CONDOMINIO
9CONGREGACION
10CONJUNTO HABITACIONAL
11CONJUNTO HABITACIONAL RESIDENCIAL
12CONJUNTO HABITACIONAL URBANO
13CONJUNTO POPULAR
14CONJUNTO RESIDENCIAL
15CONJUNTO URBANO
16CONJUNTO URBANO POPULAR
17EJIDO
18ESCUELA
19ESTACION DE RADIO
20EX-HACIENDA
21EX-RANCHO
22FABRICA
23FINCA
24FRACCIONAMIENTO
25FRACCIONAMIENTO INDUSTRIAL
26FRACCIONAMIENTO RESIDENCIAL
27GRANJA
28HACIENDA
29INGENIO
30JUNTA AUXILIA
31MODULO HABIT
32PARQUE
33PARQUE INDUS
34CUADRILLA
35POBLADO COM
36PUEBLO
37RANCHO O RAN
38RESIDENCIAL
39VILLA
40UNIDAD HABIT
41ZONA FEDERAL
42ZONA HABITAC
43ZONA INDUSTR
44ZONA RESIDEN
45ZONA URBANA
46ZONA URBANA
47CAMPO MILITA
48VIVIENDA POPU
49CLUB DE GOLF
50COOPERATIVA
51CIUDAD
52OFICINA DE CO
53GRAN USUARIO
54ZONA COMERC
55ZONA RURAL
" } } } }, "empleos": { "type": "array", "items": { "type": "object", "properties": { "nombreEmpresa": { "type": "string", "minLength": 0, "maxLength": 40 }, "direccion": { "type": "string", "minLength": 0, "maxLength": 40 }, "colonia": { "type": "string", "minLength": 0, "maxLength": 65 }, "municipio": { "type": "string", "minLength": 0, "maxLength": 65 }, "ciudad": { "type": "string", "minLength": 0, "maxLength": 65 }, "estado": { "type": "string", "enum": [ "AGS", "BC", "BCS", "CAMP", "CHIS", "CHIH", "COAH", "COL", "CDMX", "DGO", "GTO", "GRO", "HGO", "JAL", "MEX", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QROO", "SLP", "SIN", "SON", "TAB", "TAMP", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "pattern": "^\\d*$", "minLength": 0, "maxLength": 5 }, "numeroTelefono": { "type": "string", "minLength": 0, "maxLength": 20 }, "extension": { "type": "string", "minLength": 0, "maxLength": 8 }, "fax": { "type": "string", "minLength": 0, "maxLength": 20 }, "puesto": { "type": "string", "minLength": 0, "maxLength": 60 }, "fechaContratacion": { "type": "string", "format": "date" }, "claveMoneda": { "type": "string", "description": "MX: Pesos Mexicanos, US: Dólares, UD: Unidades de inversión", "enum": [ "MX", "US", "UD" ] }, "salarioMensual": { "type": "number" }, "fechaUltimoDiaEmpleo": { "type": "string", "format": "date" }, "fechaVerificacionEmpleo": { "type": "string", "format": "date" } } } }, "persona": { "nombres": { "type": "string", "minLength": 0, "maxLength": 50 }, "apellidoPaterno": { "type": "string", "minLength": 0, "maxLength": 30 }, "apellidoMaterno": { "type": "string", "minLength": 0, "maxLength": 30 }, "apellidoAdicional": { "type": "string", "minLength": 0, "maxLength": 30 }, "fechaNacimiento": { "type": "string", "format": "date" }, "rfc": { "type": "string" }, "curp": { "type": "string" }, "numeroSeguridadSocial": { "type": "string" }, "nacionalidad": { "type": "string" }, "residencia": { "type": "string", "description": "1: Propietario, 2: Renta, 3: Vive con familiares, 4: Vivienda hipotecada, 5: No disponible", "enum": [ "1", "2", "3", "4", "5" ] }, "estadoCivil": { "type": "string", "description": "D: Divorciado, L: Union libre, C: Casado, S: Soltero, V: Viudo, E: Separado", "enum": [ "D", "L", "C", "S", "V", "E" ] }, "sexo": { "type": "string", "description": "F: Femenino, M: Masculino", "enum": [ "F", "M" ] }, "claveElector": { "type": "string", "minLength": 0, "maxLength": 20 }, "numeroDependientes": { "type": "integer" }, "fechaDefuncion": { "type": "string", "format": "date" }, "domicilio": { "type": "object", "properties": { "direccion": { "type": "string", "minLength": 0, "maxLength": 85 }, "colonia": { "type": "string", "minLength": 0, "maxLength": 65 }, "municipio": { "type": "string", "minLength": 0, "maxLength": 65 }, "ciudad": { "type": "string", "minLength": 0, "maxLength": 65 }, "estado": { "type": "string", "enum": [ "AGS", "BC", "BCS", "CAMP", "CHIS", "CHIH", "COAH", "COL", "CDMX", "DGO", "GTO", "GRO", "HGO", "JAL", "MEX", "MICH", "MOR", "NAY", "NL", "OAX", "PUE", "QRO", "QROO", "SLP", "SIN", "SON", "TAB", "TAMP", "TLAX", "VER", "YUC", "ZAC" ] }, "codigoPostal": { "type": "string", "pattern": "^\\d*$", "minLength": 0, "maxLength": 5 }, "fechaResidencia": { "type": "string", "format": "date" }, "numeroTelefono": { "type": "string", "minLength": 0, "maxLength": 20 }, "tipoDomicilio": { "type": "string", "enum": [ "N", "O", "C", "P", "E" ] }, "tipoAsentamiento": { "type": "string", "description": "
ClaveTipo de Asentamiento
0PENDIENTE POR ACTUALIZAR
1AEROPUERTO
2BARRIO
3BASE NAVAL
4CAMPAMENTO
5CENTRO
6CENTRO URBANO
7COLONIA
8CONDOMINIO
9CONGREGACION
10CONJUNTO HABITACIONAL
11CONJUNTO HABITACIONAL RESIDENCIAL
12CONJUNTO HABITACIONAL URBANO
13CONJUNTO POPULAR
14CONJUNTO RESIDENCIAL
15CONJUNTO URBANO
16CONJUNTO URBANO POPULAR
17EJIDO
18ESCUELA
19ESTACION DE RADIO
20EX-HACIENDA
21EX-RANCHO
22FABRICA
23FINCA
24FRACCIONAMIENTO
25FRACCIONAMIENTO INDUSTRIAL
26FRACCIONAMIENTO RESIDENCIAL
27GRANJA
28HACIENDA
29INGENIO
30JUNTA AUXILIA
31MODULO HABIT
32PARQUE
33PARQUE INDUS
34CUADRILLA
35POBLADO COM
36PUEBLO
37RANCHO O RAN
38RESIDENCIAL
39VILLA
40UNIDAD HABIT
41ZONA FEDERAL
42ZONA HABITAC
43ZONA INDUSTR
44ZONA RESIDEN
45ZONA URBANA
46ZONA URBANA
47CAMPO MILITA
48VIVIENDA POPU
49CLUB DE GOLF
50COOPERATIVA
51CIUDAD
52OFICINA DE CO
53GRAN USUARIO
54ZONA COMERC
55ZONA RURAL
" } } } }, "scores": { "type": "array", "items": { "type": "object", "properties": { "nombreScore": { "type": "string" }, "valor": { "type": "number" }, "score": { "type": "number" }, "razones": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "object", "properties": { "clave": { "type": "string" }, "descripcion": { "type": "string" } } } } ] } } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "401": { "description": "Unauthorized response", "content": { "application/json": { "schema": { "type": "object", "description": "Unauthorized response", "properties": { "statusCode": { "type": "number", "enum": [ 401 ] }, "error": { "type": "string", "enum": [ "Unauthorized" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "403": { "description": "Forbidden response", "content": { "application/json": { "schema": { "type": "object", "description": "Forbidden response", "properties": { "statusCode": { "type": "number", "enum": [ 403 ] }, "error": { "type": "string", "enum": [ "Forbidden" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "404": { "description": "Not Found response", "content": { "application/json": { "schema": { "type": "object", "description": "Not Found response", "properties": { "statusCode": { "type": "number", "enum": [ 404 ] }, "error": { "type": "string", "enum": [ "Not Found" ] }, "message": { "type": "string" } }, "additionalProperties": false } } } }, "429": { "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "content": { "application/json": { "schema": { "type": "object", "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "properties": { "id": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 429 ] }, "error": { "type": "string", "enum": [ "Too Many Requests" ] }, "message": { "type": "string", "enum": [ "Has excedido el limite de uso de cuenta de moffin. Escribe a soporte de moffin." ] } }, "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } }, { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": false, "properties": { "errores": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string", "example": "400.1" }, "mensaje": { "type": "string" } } } } } }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } ] } } } } } } }, "/api/v1/query/bl-busqueda_judicial": { "post": { "tags": [ "Query data sources" ], "description": "Buho Legal \"busqueda legal\" report", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^\\s*[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ&\\.\\-,'`’<>()/]+[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true, "minLength": 1 }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "accountType": { "type": "string", "enum": [ "PM" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "accountType", "tradeName" ], "anyOf": [ { "title": "Birthdate", "properties": { "birthdate": { "type": "string", "format": "date", "description": "Example: \"1980-01-20\"", "nullable": true } } }, { "title": "Date and time of birth", "properties": { "birthdate": { "type": "string", "format": "date-time", "description": "Example: \"1980-01-20T00:00:00+00\" ISO timestamps are allowed but the time part is ignored.", "nullable": true } } } ] }, { "type": "object", "additionalProperties": false, "properties": { "email": { "type": "string", "format": "email", "nullable": true }, "externalId": { "type": "string", "maxLength": 256, "nullable": true }, "firstName": { "type": "string", "maxLength": 256, "pattern": "^\\s*[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’.-]+[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "minLength": 1 }, "middleName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "maxLength": 256, "pattern": "^\\s*[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’.-]+[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "minLength": 1 }, "secondLastName": { "type": "string", "maxLength": 256, "pattern": "^\\s*[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’.-]+[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true, "minLength": 1 }, "tradeName": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "rfc": { "type": "string", "minLength": 12, "maxLength": 13, "description": "RFC with homoclave", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": true, "required": true } }, "nullable": true }, "basicRFC": { "type": "string", "minLength": 9, "maxLength": 10, "description": "RFC without homoclave. If it is `null`, it will autocomplete using the `RFC` field (RFC with homoclave).", "RFCValidator": { "rfcType": "ALL", "homoclave": { "enabled": false, "required": false } }, "nullable": true }, "phone": { "type": "string", "maxLength": 256, "description": "In prospector PF service if the number it's not mexican, is omitted in the service", "PhoneValidator": { "allowNull": true }, "nullable": true }, "curp": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "minLength": 18, "maxLength": 18, "nullable": true, "CURPValidator": {} }, "accountType": { "type": "string", "enum": [ "PF" ] }, "neighborhood": { "type": "string", "maxLength": 256, "nullable": true }, "address": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "address2": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "city": { "type": "string", "maxLength": 256, "nullable": true }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC", "AGS", "CHS", "CHI", "CDMX", "DGO", "GTO", "HGO", "EM", "MICH", "NL", "QRO", "QR", "TLAX", null ], "description": "ISO 3166-2:MX codes (ignoring `MX-` prefix), bureau codes are converted to ISO codes. https://www.iso.org/obp/ui/#iso:code:3166:MX", "nullable": true }, "zipCode": { "anyOf": [ { "type": "string", "minLength": 5, "maxLength": 5, "ZipCodeMatchState": true, "nullable": true }, { "type": "string", "maxLength": 0, "nullable": true } ], "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "exteriorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "interiorNumber": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "country": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "nullable": true }, "municipality": { "type": "string", "maxLength": 256, "nullable": true }, "nationality": { "type": "string", "maxLength": 256, "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW", null ], "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "accountType", "firstLastName" ], "anyOf": [ { "type": "object", "required": [ "firstName" ], "properties": { "firstName": { "type": "string" } } }, { "type": "object", "required": [ "secondLastName" ], "properties": { "secondLastName": { "type": "string" } } } ] } ], "properties": { "nationality": { "type": "string", "default": "MX" }, "country": { "type": "string", "default": "MX" } } } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true } } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 400 ] }, "error": { "type": "string" }, "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "instancePath": { "type": "string" }, "params": { "type": "object" }, "data": {} }, "additionalProperties": false } } } } } } }, "429": { "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "content": { "application/json": { "schema": { "type": "object", "description": "Usually, we send this error when you have reached your API limit usage. If this is the case, please contact team@moffin.mx", "properties": { "id": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 429 ] }, "error": { "type": "string", "enum": [ "Too Many Requests" ] }, "message": { "type": "string", "enum": [ "Has excedido el limite de uso de cuenta de moffin. Escribe a soporte de moffin." ] } }, "additionalProperties": false } } } }, "500": { "description": "Error schema", "content": { "application/json": { "schema": { "type": "object", "description": "Error schema", "title": "Error schema", "properties": { "id": { "type": "string" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" }, "description": { "type": "string" } } } } } } } } }, "/api/v1/report": { "get": { "tags": [ "reports" ], "description": "Get reports. The endpoint is deprecated, we recommend to use the [*ServiceQueries* endpoint](#tag/Service-queries/paths/~1api~1v1~1service_queries/get).", "parameters": [ { "schema": { "type": "integer", "minimum": 10, "maximum": 2000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "DESC", "ASC" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "profileId", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "formId", "required": false }, { "schema": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "default": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "in": "query", "name": "service", "required": false, "description": "To send an array you must send several times service=value as in the following examples: service=sat_rfc&service=bureau_pf or service[]=sat_rfc&service[]=bureau_pf " }, { "schema": { "type": "object", "additionalProperties": false, "properties": { "from": { "type": "string", "format": "date-time", "description": "Return reports created at or after this timestamp" }, "to": { "type": "string", "format": "date-time", "description": "Return reports created at of before this timestamp" } } }, "in": "query", "name": "createdAt", "required": false, "description": "Filter reports by createdAt timestamps. Use timestamps in ISO format. Use the format createdAt[from]=\"timestamp\" and createdAt[to]=\"timestamp\" to query reports within a date" } ], "deprecated": true, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "reports": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": true, "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "pdfURL": { "type": "string", "description": "

Link to download PDF file. The link has a lifetime of 15 minutes. withPDF property should be set as true.We generate a new link each time you request this endpoint.

" } } } } } } } } } } } }, "/api/v1/report/{id}": { "get": { "tags": [ "reports" ], "description": "Get report by ID", "parameters": [ { "schema": { "enum": [ "true", "false" ], "default": "false" }, "in": "query", "name": "withPDF", "required": false, "description": "

Enable this flag to generate a link to downloadthe PDF file. The link will be available in the pdfURL property. Only bureau_pf and bureau_pm reports have this service available. Each link expires in 15 minutes.

" }, { "schema": { "type": "number" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": true, "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "pdfURL": { "type": "string", "description": "

Link to download PDF file. The link has a lifetime of 15 minutes. withPDF property should be set as true.We generate a new link each time you request this endpoint.

" } } } } } } } } }, "/api/v1/service_queries": { "get": { "tags": [ "Service queries" ], "description": "Get service queries", "parameters": [ { "schema": { "type": "integer", "minimum": 10, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "DESC", "ASC" ] }, "in": "query", "name": "order", "required": false, "description": "Returns results ordered by `createdAt` in ascending or descending order respectively. Keep in mind this is the date the query was first executed, not its completion date." }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false, "description": "Specify a string to search for in the metadata of each query. This includes names, address fields and RFCs. For instance, using a specific RFC in this field would return all queries for that RFC. You can only search for a single parameter at this time." }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "profileId", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "formId", "required": false }, { "schema": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "default": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "in": "query", "name": "service", "required": false, "description": "To send an array you must send several times service=value as in the following examples: service=sat_rfc&service=bureau_pf or service[]=sat_rfc&service[]=bureau_pf " }, { "schema": { "type": "object", "additionalProperties": false, "properties": { "from": { "type": "string", "format": "date-time", "description": "Return reports created at or after this timestamp" }, "to": { "type": "string", "format": "date-time", "description": "Return reports created at of before this timestamp" } } }, "in": "query", "name": "createdAt", "required": false, "description": "Filter reports by createdAt timestamps. Use timestamps in ISO format. Use the format createdAt[from]=\"timestamp\" and createdAt[to]=\"timestamp\" to query reports within a date" }, { "schema": { "type": "boolean", "default": false }, "in": "query", "name": "withFileURL", "required": false, "description": "If set `true` it will generate a link to download the available files for `sat_rfc` and `sat_1` services. Allowing this flag will increase request response considerably." }, { "schema": { "type": "boolean", "default": false }, "in": "query", "name": "includeDetailedTags", "required": false, "description": "Returns detailed tag object" }, { "schema": { "type": "object", "properties": { "profileId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact profileId." }, "profileId__gt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId greater than specified value." }, "profileId__gte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId less than specified value." }, "profileId__lt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId less than specified value." }, "profileId__lte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by profileId less than specified value." }, "profileId__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified profileId." }, "service__eq": { "anyOf": [ { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, { "type": "array", "items": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] } } ], "description": "Filter by exact service." }, "service__anyOf": { "anyOf": [ { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, { "type": "array", "items": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] } } ], "description": "Filter by any of the specified service." }, "formId__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact formId." }, "formId__gt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formId greater than specified value." }, "formId__gte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formId less than specified value." }, "formId__lt": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formId less than specified value." }, "formId__lte": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by formId less than specified value." }, "formId__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified formId." }, "createdAt__eq": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by exact createdAt." }, "createdAt__gt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt greater than specified value." }, "createdAt__gte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt less than specified value." }, "createdAt__isNull": { "type": "boolean", "description": "Filter by createdAt is null or not." }, "createdAt__lt": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt less than specified value." }, "createdAt__lte": { "type": "string", "format": "date-time", "description": "Datetime(ISO 8601) with milliseconds. Filter by createdAt less than specified value." }, "status__eq": { "anyOf": [ { "type": "string", "enum": [ "PENDING", "FAIL", "SUCCESS" ] }, { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "FAIL", "SUCCESS" ] } } ], "description": "Filter by exact status." }, "status__anyOf": { "anyOf": [ { "type": "string", "enum": [ "PENDING", "FAIL", "SUCCESS" ] }, { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "FAIL", "SUCCESS" ] } } ], "description": "Filter by any of the specified status." }, "tagIds__anyOf": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by any of the specified tagIds." }, "tagIds__eq": { "anyOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ], "description": "Filter by exact tagIds." }, "tags__anyOf": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by any of the specified tags." }, "tags__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact tags." }, "externalId__eq": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Filter by exact externalId." }, "searchVector__search": { "type": "string", "description": "Filter using full-text search on specified fields(query)." } } }, "in": "query", "name": "filter", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "serviceQueries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "uuid": { "type": "string" }, "authentication": { "type": "string", "enum": [ "MOFFIN", "CUSTOM" ] }, "service": { "type": "string", "enum": [ "bureau_pf", "bureau_pm", "bureau_pf_intl", "bureau_pm_intl", "bl-busqueda_judicial", "prospector_pf", "jumio_id_validation", "renapo_curp", "sat_1", "sat_rfc", "imss_job_history", "ca_blacklist", "circulo_credito_pf" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "PENDING" ] }, "state": { "type": "object", "additionalProperties": true, "nullable": true }, "metadata": { "type": "object", "properties": { "clientType": { "type": "string" }, "reportType": { "type": "string" }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "headers": { "type": "object", "additionalProperties": true, "properties": { "requestOrigin": { "type": "string", "enum": [ "ONLY_MOCKS", "DOWN", "MIXED" ] }, "responseOrigin": { "nullable": true, "type": "string", "enum": [ "MOCK", "BURO" ] } } } } }, "query": { "type": "object", "additionalProperties": true, "nullable": true }, "response": { "type": "object", "additionalProperties": true, "nullable": true }, "requesterId": { "type": "number" }, "organizationId": { "type": "number" }, "profileId": { "type": "number", "nullable": true }, "formId": { "type": "number", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "requester": { "type": "object", "additionalProperties": true, "nullable": true }, "cachedFrom": { "type": "number", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer" }, "minItems": 0 }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsAssociation": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "minItems": 0, "nullable": true }, "pdfURL": { "type": "string", "description": "

Link to download PDF file. The link has a lifetime of 15 minutes. withPDF property should be set as true.We generate a new link each time you request this endpoint.

" } } } } } } } } } } } }, "/api/v2/submissions/{formConfigId}": { "post": { "tags": [ "submissions" ], "description": "Endpoint to create new submissions(Old Forms)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "type": "object", "title": "Persona Física", "properties": { "phone": { "type": "string", "description": "In prospector PF service, if the number is not Mexican, it is omitted in the service", "PhoneValidator": { "allowNull": false } }, "email": { "type": "string", "format": "email" }, "nationality": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "description": "Use ISO 3166-1 alpha-2 codes for the nationality country" }, "address": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "address2": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "exteriorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "interiorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "nullable": true, "description": "Use ISO 3166-1:MX codes for state" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "country": { "type": "string", "enum": [ "MX" ] }, "municipality": { "type": "string" }, "extraInformation": { "type": "string", "maxLength": 1024, "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "monthlyIncome": { "type": "integer", "minimum": 0, "nullable": true }, "loanAmount": { "type": "integer", "minimum": 1, "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accountType": { "type": "string", "enum": [ "PF" ] }, "firstName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "middleName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "firstLastName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$" }, "secondLastName": { "type": "string", "pattern": "^[a-zA-ZñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ'`’\\s.-]*$", "nullable": true }, "rfc": { "type": "string", "description": "RFC for \"Persona Fisica\" forms should have a length of 10 or 13 characters, and letters should be uppercase. \"Homoclave\" can be optional or required, depending on the form configuration" }, "curp": { "type": "string", "pattern": "^([A-Z][AEIOUX][A-Z]{2}\\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\\d|3[01])[HM](?:AS|B[CS]|C[CLMSH]|D[FG]|G[TR]|HG|JC|M[CNS]|N[ETL]|OC|PL|Q[TR]|S[PLR]|T[CSL]|VZ|YN|ZS)[B-DF-HJ-NP-TV-Z]{3}[A-Z\\d])(\\d)$" }, "birthdate": { "type": "string", "format": "date", "formatMaximum": "2020-01-01" } }, "additionalProperties": false, "required": [ "accountType" ] }, { "type": "object", "title": "Persona Moral", "properties": { "phone": { "type": "string", "description": "In prospector PF service, if the number is not Mexican, it is omitted in the service", "PhoneValidator": { "allowNull": false } }, "email": { "type": "string", "format": "email" }, "nationality": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "enum": [ "AF", "AL", "DE", "AD", "AO", "AI", "AQ", "AG", "SA", "DZ", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BY", "BO", "BQ", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BT", "CV", "KH", "CM", "CA", "CL", "CN", "CY", "CO", "CI", "CR", "HR", "CU", "CW", "DK", "DJ", "DM", "EC", "EG", "SV", "ER", "SK", "SI", "ES", "US", "EE", "ET", "FJ", "PH", "FI", "FR", "GA", "GM", "GS", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GY", "GF", "GG", "GN", "GW", "HT", "HN", "HK", "HU", "IN", "ID", "IQ", "IR", "IE", "BV", "IM", "CX", "HM", "NF", "IS", "AX", "KY", "CK", "FK", "FO", "MP", "MH", "PN", "RE", "SB", "VI", "VG", "IL", "IT", "JM", "JP", "JE", "JO", "QA", "KZ", "KE", "KG", "KI", "KW", "SY", "KR", "CD", "KP", "LA", "UM", "TC", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "AE", "NL", "LU", "MO", "MK", "MG", "MY", "MW", "MV", "ML", "MT", "MA", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NI", "NE", "NG", "NU", "NO", "NC", "NZ", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PF", "PL", "PT", "PR", "GB", "CF", "CZ", "GE", "MM", "TD", "CG", "ST", "TL", "DO", "TZ", "RW", "RO", "RU", "EH", "AS", "WS", "BL", "KN", "SM", "MF", "PM", "VC", "SH", "LC", "SN", "RS", "SC", "SL", "SG", "SX", "SO", "LK", "ZA", "SD", "SS", "SE", "CH", "SR", "SJ", "SZ", "TH", "TW", "TJ", "IO", "CC", "TF", "TG", "TK", "TO", "TT", "TN", "TM", "TR", "TV", "UA", "UG", "KM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "YE", "ZM", "ZW" ], "description": "Use ISO 3166-1 alpha-2 codes for the nationality country" }, "address": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "address2": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "exteriorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "interiorNumber": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$", "nullable": true }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "enum": [ "AGU", "BCN", "BCS", "CAM", "CHP", "CHH", "CMX", "COA", "COL", "DUR", "GUA", "GRO", "HID", "JAL", "MEX", "MIC", "MOR", "NAY", "NLE", "OAX", "PUE", "QUE", "ROO", "SLP", "SIN", "SON", "TAB", "TAM", "TLA", "VER", "YUC", "ZAC" ], "nullable": true, "description": "Use ISO 3166-1:MX codes for state" }, "zipCode": { "type": "string", "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "ZipCodeMatchState": true, "description": "Zip code must match to state. First two digits identify the state or part thereof to which it belongs. For example: zip code 01455, 01 corresponds to CMX state\n\nMore info: https://www.correosdemexico.gob.mx/SSLServicios/ConsultaCP/Descarga.aspx" }, "country": { "type": "string", "enum": [ "MX" ] }, "municipality": { "type": "string" }, "extraInformation": { "type": "string", "maxLength": 1024, "nullable": true }, "nss": { "type": "string", "NSSValidator": true, "nullable": true }, "monthlyIncome": { "type": "integer", "minimum": 0, "nullable": true }, "loanAmount": { "type": "integer", "minimum": 1, "nullable": true }, "customPagesAnswers": { "type": "object", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accountType": { "type": "string", "enum": [ "PM" ] }, "tradeName": { "type": "string", "pattern": "^[a-zA-Z0-9ñÑáÁéÉíÍóÓúÚäÄëËïÏöÖüÜÿŸâÂêÊôÔàÀãÃõÕçÇ@&\\.\\-\\s,'`’<>()/]*$" }, "rfc": { "type": "string", "description": "RFC for \"Persona Moral\" forms should have a length of 9 or 12 characters, and letters should be uppercase. \"Homoclave\" can be optional or required, depending on the form configuration" } }, "additionalProperties": false, "required": [ "accountType" ] } ] } } } }, "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "formConfigId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "additionalProperties": false } } } } } } }, "/api/v2/submissions/{formId}/complete": { "post": { "tags": [ "submissions" ], "description": "Endpoint to complete a submission(Old Forms)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validateNIPAuthentication": { "type": "boolean" } }, "required": [ "validateNIPAuthentication" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "number" }, "in": "path", "name": "formId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "jumioRedirectUrl": { "type": "string" } }, "required": [ "id", "jumioRedirectUrl" ], "additionalProperties": false } } } } } } } }, "servers": [ { "url": "https://sandbox.moffin.mx", "description": "Moffin Sandbox" }, { "url": "https://app.moffin.mx", "description": "Moffin Production" } ], "tags": [ { "name": "data", "description": "Data Collection & Document related end-points" }, { "name": "reports", "description": "Report related end-points" }, { "name": "profiles", "description": "Profile related end-points" }, { "name": "postal codes", "description": "Postal codes related end-points" }, { "name": "Query data sources", "description": "Endpoints related to query a service" }, { "name": "Service queries", "description": "Endpoints related to getting service queries" }, { "name": "Credentials", "description": "Credentials related endpoints" } ] }