Create new document type

Create new document type

POST {{Environment_URL}}/v1/clients

This mutation is responsible to create a new document type of an existing client, with a logged user correspondent.

Before execute the mutation, you have to upload a document image file relative to the client. For more information about this procedure, see the Generate AWS signature section and follow the process.

• Pass an Authorization header

• Pass the valid client key on header

• Pass the client CPF document

• Pass a valid document structure

  • Available document types: RG, CNH, OTHER

  • Valid key from previous uploading document image

  • Available side: FRONT, BACK

  • Pass two files on the version, one for front side and other for back side

• The files structure inside of versions can have a optional property named imageUrl that will not return any value when you are creating a new document or a new version.

Headers

Name	Value
Authorization	Bearer <token>
client-key	123ABCD456

Body (GraphQl) - MUTATION

Query

mutation($cpf: String!, $document: [DocumentInput]!) {
    createNewDocumentType(
        cpf: $cpf
        document: $document
    ) {
        documentType
        documentValues
        versions {
        files {
            key
            side
        }
        idWallReport
        approved
        createdAt
        }
    }
}

GraphQl Variables

Response

200 - Adding OTHER type of document

{
    "data": {
        "createNewDocumentType": [
            {
                "documentType": "OTHER",
                "documentValues": null,
                "versions": [
                    {
                        "files": [
                            {
                                "key": "document/users/304/2019-10-16-front-l5ibLCnScft4TdqRiODJJg.jpeg",
                                "side": "FRONT"
                            },
                            {
                                "key": "document/users/304/2019-10-16-front-l5ibLCnScft4TdqRiODJJg.jpeg",
                                "side": "BACK"
                            }
                        ],
                        "idWallReport": null,
                        "approved": true,
                        "createdAt": "2020-10-26T14:53:07.021Z"
                    }
                ]
            }
        ]
    }
}

200 - Adding a CNH document

200 - Adding RG Document

422 - Document type already registered