Registros

Solicitando um novo registro

Criar solicitações de registro em lote

POST https://registroeletronico-homolog.cdxti.com.br/api/registration-requests-bulk

Cria um lote de solicitações de registro

Headers

Name	Type	Description
Authorization	Bearer Token	Token gerado pelo método de autenticação

Request Body

Name	Type	Description
partnerRegistrationId*	string	Id do registro no sistema do parceiro. Deve ser ÚNICO e controlado pelo cliente.
customerIdentifier*	string	CNPJ do cliente para qual o registro será realizado
ibgeCode*	string	Código IBGE do município do cliente
contractNumber*	string	Número do contrato emitido pelo cliente
registerTypes*	array	Tipo do pedido de registro
procedureType*	string	Tipo de procedimento (REGISTRO|ASSINATURA_REGISTRO)
organization*	object	Organização do parceiro
participants*	array	Lista de partes que fazem parte do registro.
documents*	array	Documentos que serão registrados no cartório

200: OK OK

[
    {
        "id": "4164",
        "partnerRegistrationId": "00000000000000000001",
        "customerIdentifier": "20061411000102",
        "status": "SUCCESS",
        "message": "Registration accepted"
    },
    {
        "id": null,
        "partnerRegistrationId": "00000000000000000001",
        "customerIdentifier": "20061411000102",
        "status": "FAIL",
        "message": "Principal document not informed"
    }
]

400: Bad Request Bad request

{
    "type": "https://zalando.github.io/problem/constraint-violation",
    "title": "Constraint Violation",
    "status": 400,
    "path": "/api/registration-requests-bulk",
    "violations": [
        {
            "field": "createRegistrationRequestBulk.registrationRequests[0].partnerRegistrationId",
            "message": "must not be null"
        }
    ],
    "message": "error.validation"
}

401: Unauthorized Permission denied

Organization - Schema

{
    "identifier": "00000000000000" // CNPJ | String | Required | mix = 14, max = 14
}

Participant - Schema

{
    "name": "Participante Um", // String | Required | max = 50
    "identifier": "00000000001", // CPF | String | Required | min = 11, max = 11
    "documentType": "CPF", // String | Required | values = {CPF}
    "qualifier": "ASSINADOR", // String | Required | values = { ASSINADOR | APROVADOR }
    "phoneNumber": "4199999999", // String | Required
    "hasCertificate": true, // Boolean | Required
    "hasDriverLicense": false, // Boolean | Required
    "email": "[e-mail]" // String | Required | max = 50,
    "title": "SIGNATARIO" // String | See paticipant title list Ex.: { CLIENTE | COMPRADOR | DEVEDOR | ...}
}

Document - Schema

{
    "isPrincipal": true, // Boolean | Required
    "documentType": "CPR", // String | Required | values = {CPR|CCB|CCI|CONTRATO|OUTROS}
    "documentUrl": "https://www.url.com.br/doc.pdf" // Presigned URL generated by 'URL de Documento' endpoint
}

RegisterType - Schema

[
    {
        "serviceType": "RTD", // String | Required | values = {RGI|RTD}
        "ibgeCode": "400120", // String | Required | max = 20
    }
]

Exemplo de Payload Completo

[
    {
        "organization": {
            "identifier": "00000000000000" // CNPJ do parceiro
        },
        "partnerRegistrationId": "18238167237678130",
        "customerIdentifier": "00000000000000",
        "contractNumber": "12356789",
        "registerTypes": [
            {
                "serviceType": "RGI",
                "ibgeCode": "400120"
            }
        ],
        "procedureType": "ASSINATURA_REGISTRO", // String | Required | values = {REGISTRO|ASSINATURA_REGISTRO}
        "participants": [ // Required if "procedureType" = ASSINATURA_REGISTRO
            {
                "name": "Participante Um",
                "identifier": "00000000001",
                "documentType": "CPF",
                "qualifier": "ASSINADOR",
                "phoneNumber": "4199999999",
                "hasCertificate": true,
                "hasDriverLicense": false,
                "email": "[e-mail]",
                "title": "SIGNATARIO"
            },
            {
                "name": "Participante Dois",
                "identifier": "00000000002",
                "documentType": "CPF",
                "qualifier": "ASSINADOR",
                "phoneNumber": "4199999999",
                "hasCertificate": true,
                "hasDriverLicense": false,
                "email": "[e-mail]",
                "title": "SIGNATARIO"
            },
            {
                "name": "Participante Tres",
                "identifier": "00000000003",
                "documentType": "CPF",
                "qualifier": "ASSINADOR",
                "phoneNumber": "4199999999",
                "hasCertificate": true,
                "hasDriverLicense": false,
                "email": "[e-mail]",
                "title": "SIGNATARIO"
            }
        ],
        "documents": [
            {
                "isPrincipal": true, // Only one main document (isPrincipal=true) is allowed
                "documentType": "CPR", 
                "documentUrl": "https://www.url.com.br/doc.pdf"
            },
            {
                "isPrincipal": false,
                "documentType": "OUTROS",
                "documentUrl": "https://www.url.com.br/doc.pdf"
            },
            {
                "isPrincipal": false,
                "documentType": "OUTROS",
                "documentUrl": "https://www.url.com.br/doc.pdf"
            }
        ]
    }
]

O atributo partnerRegistrationId é obrigatório e deve ser único. O controle de unicidade deve ser feito pelo consumidor da API.