跳到主要内容

标准

为了简化集成并确保信息完整性,定义了一些在整个 API 中遵循的标准。

带时区的日期和时间

一些示例:

2019-10-15T22:35:12-03:00
2018-05-01T13:32:11+00:00
2019-05-01T00:00:00+00:00

按照 ISO 8601 表示。在这种情况下,时区紧跟在时间后面,应表示该数据有效的当地时区。例如,如果租用计划在巴西利亚机场 09:30 开始,发送的时间应表示为 09:30-03:00;如果租用计划在马瑙斯 09:30 开始,则应表示为 09:30-04:00。

用于验证的掩码如下:

YYYY-MM-ddThh:mm:ss±hh:mm

不带时区的日期和时间

一些示例:

2019-10-15T22:35:12Z
2018-05-01T13:32:11Z
2019-05-01T00:00:00Z

按照 ISO 8601 表示。与时区无关的数据应以不带时区的形式发送,始终使用 UTC,字母 Z 表示该数据为 UTC。因此,将验证以下格式:

YYYY-MM-ddThh:mm:ssZ

日期

一些示例

2019-10-15
2019-01-01
2017-03-20

对于只接受日期的字段(例如出生日期),只应发送日期,不含任何时间,格式如下:

YYYY-MM-dd

文档

由于文档号码种类繁多,其中许多包含非数字字符,所有文档号码均定义为字符串。将其定义为字符串的另一个好理由是避免前导零消失。本页中规定的文档具有明确的掩码,将进行验证。其余文档(如 RG)由于缺乏标准化,将不进行验证。

CPF

对照定义掩码的有效 CPF 示例:

123.456.789-12
321.987.543-23
111.283.333-00

对照定义掩码的无效 CPF 示例:

8.577.477-8
08.104.627/0001-23
123.456.789-1
23.456.789-01

CPF 始终定义为字符串,将对照以下掩码进行验证:

###.###.###-##