Banco Privado de Faces

Listar faces

GET

https://api.combateafraude.com/private-faceset?token=<ACCESS_TOKEN>

Requisição

Descrição dos atributos da requisição

TipoFormatoNomeDescriçãoObservações
QueryStringtokenToken de acessoObrigatório
QueryString_limitLimite de resultados da requisiçãoDefault 20
QueryString_offsetNúmero de registros que devem ser desconsideradosDefault 0
QueryBoolean_galleryFormatAltera o formato do resposta, retornando as imagens separadamente

Exemplo de requisição - cURL

$ curl --location --request GET \
    --url https://api.combateafraude.com/private-faceset?token=<ACCESS_TOKEN> \
    --header "Content-Type: application/json"

Resposta

Descrição dos atributos da resposta

AtributoDescrição
statusCodeStatus code da requisição
headersHeaders de controle
docsArray de objetos dos registros
docs._idIdentificador do registro
docs.createdAtData de criação do registro
docs.cpfCPF do registo
docs.descriptionDescrição do registo
docs.imagesArray das imagens de faces do registro
docs.updatedAtData da última atualização do registro
totalItemsNúmero total de registros

Exemplo de resposta - JSON

{
    "statusCode": 200,
    "headers": {
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "docs": [
        {
            "_id": "5f56f09852147700014f406",
            "createdAt": "2019-08-16T18:05:09.885Z",
            "cpf": "00000000000",
            "description": "Imagem de teste",
            "images": [
                "https://caf-83724234d9-43d-4447-8c6-0b123fd73.s3.amazonaws.com/private_faceset_5f56f09852147700014f406_1596650921102.jpg...",
                "https://caf-83724234d9-43d-4447-8c6-0b123fd73.s3.amazonaws.com/private_faceset_5f56f09852147700014f406_1597164343555.jpg..."
            ],
            "updatedAt": "2019-08-16T18:05:11.387Z"
        }
    ],
    "totalItems": 1
}

Exemplo de resposta com _galleryFormat=true - JSON

{
    "statusCode": 200,
    "headers": {
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "docs": [
        {
            "_id": "5f56f09852147700014f406",
            "cpf": "00000000000",
            "description": "Imagem de teste",
            "image": "https://caf-83724234d9-43d-4447-8c6-0b123fd73.s3.amazonaws.com/private_faceset_5f56f09852147700014f406_1596650921102.jpg...",
        },
        {
            "_id": "5f56f09852147700014f406",
            "cpf": "00000000000",
            "description": "Imagem de teste",
            "image": "https://caf-83724234d9-43d-4447-8c6-0b123fd73.s3.amazonaws.com/private_faceset_5f56f09852147700014f406_1597164343555.jpg...",
        }
    ],
    "totalItems": 2
}

Listar face específica

GET

https://api.combateafraude.com/private-faceset/{FACESET_ID}?token=<ACCESS_TOKEN>

Requisição

Descrição dos atributos da requisição

TipoFormatoNomeDescriçãoObservações
PathStringFACESET_IDIdentificador do registroObrigatório
QueryStringtokenToken de acessoObrigatório

Exemplo de requisição - cURL

$ curl --location --request GET \
    --url https://api.combateafraude.com/private-faceset/{FACESET_ID}?token=<ACCESS_TOKEN> \
    --header "Content-Type: application/json"

Resposta

Descrição dos atributos da resposta

AtributoDescrição
statusCodeStatus code da requisição
headersHeaders de controle
body._idIdentificador do registro
body.createdAtData de criação do registro
body.cpfCPF do registro
body.descriptionDescrição do registro
body.imagesArray das imagens de faces do registro
body.updatedAtData da última atualização do registro

Exemplo de resposta - JSON

{
    "statusCode": 200,
    "headers": {
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "_id": "5f56f09852147700014f406",
        "createdAt": "2019-08-16T18:05:09.885Z",
        "cpf": "00000000000",
        "description": "Imagem de teste",
        "images": [
            "https://caf-83724234d9-43d-4447-8c6-0b123fd73.s3.amazonaws.com/private_faceset_5f56f09852147700014f406_1596650921102.jpg..."
        ],
        "updatedAt": "2019-08-16T18:05:11.387Z"
    }
}

Cadastrar face

POST

https://api.combateafraude.com/private-faceset?token=<ACCESS_TOKEN>

Requisição

Descrição dos atributos da requisição

TipoFormatoNomeDescriçãoObservações
QueryStringtokenToken de AcessoObrigatório
BodyStringcpfCPF que será vinculado à faceOpcional
BodyStringdescriptionDescrição que será vinculada à faceObrigatório
BodyArrayimagesImagens de faces a serem cadastradasURI ou base64 (recomendamos URI)

Exemplo de requisição - cURL

$ curl --location --request POST \
    --url https://api.combateafraude.com/private-faceset?token=<ACCESS_TOKEN> \
    --header "Content-Type: application/json" \
    --data '{ "cpf": "00000000000", "description": "Teste", "images": ["http://face.jpg"] }'

Resposta

Descrição dos atributos da resposta

AtributoDescrição
statusCodeStatus code da requisição
headersHeaders de controle
messageMensagem da situação da cadastro

Exemplo de resposta - JSON

{
    "statusCode": 200,
    "headers": {
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "message": "Cadastro realizado com sucesso"
}

Remover face

DELETE

https://api.combateafraude.com/private-faceset/{FACESET_ID}?token=<ACCESS_TOKEN>

Requisição

Descrição dos atributos da requisição

TipoFormatoNomeDescriçãoObservações
PathStringFACESET_IDIdentificador do registroObrigatório
QueryStringtokenToken de acessoObrigatório

Exemplo de requisição - cURL

$ curl --location --request DELETE \
    --url https://api.combateafraude.com/private-faceset/{FACESET_ID}?token=<ACCESS_TOKEN> \
    --header "Content-Type: application/json"

Resposta

Descrição dos atributos da resposta

AtributoDescrição
statusCodeStatus code da requisição
headersHeaders de controle
messageMensagem da situação da exclusão

Exemplo de resposta - JSON

{
    "statusCode": 200,
    "headers": {
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "message": "Registro removido com sucesso"
}

Comparar imagem na base de dados

Requisição

POST

https://api.combateafraude.com/private-faceset/search?token=<ACCESS_TOKEN>

Descrição dos atributos da requisição

TipoFormatoNomeDescriçãoObservações
QueryStringtokenToken de acessoObrigatório
BodyStringimageImagem a ser comparada com as da base de facesDeve ser em base64

Exemplo de requisição - cURL

$ curl --location --request POST \
    --url https://api.combateafraude.com/private-faceset/search?token=<ACCESS_TOKEN> \
    --header "Content-Type: application/json" \
    --data "{
        \"image\": \"<BASE64_IMAGE>\"
    }"

Resposta

Descrição dos atributos da resposta

AtributoDescrição
statusCodeStatus code da requisição
headersHeaders de controle
faceMatchesArray de registros com faces similares encontrados
faceMatches.similarityNível de similaridade da face enviada com a face encontrada na base
faceMatches._idIdentificador do registro
faceMatches.createdAtData de criação do registro
faceMatches.cpfCPF do registro
faceMatches.descriptionDescrição do registro
faceMatches.imageImagem encontrada na base
faceMatches.updatedAtData da última atualização do registro
faceMatches.face
faceMatches.face.faceIdIdentificador da face
faceMatches.face.imageIdIdentificador da imagem
faceMatches.face.privateFacesetIdIdentificador do registro encontrado. Idêntico ao _id
faceMatches.face.confidenceNível de confiança de que existe uma face na imagem

Exemplo de resposta - JSON

{
    "statusCode": 200,
    "headers": {
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "faceMatches": [
        {
            "similarity": 99.99999237060547,
            "_id": "5d65674cc4458a0007add467",
            "createdAt": "2020-08-05T18:08:40.700Z",
            "cpf": "00000000000",
            "description": "Imagem...",
            "image": "https://caf-83724234d9-43d-4447-8c6-0b123fd73.s3.amazonaws.com/private_faceset_5f56f09852147700014f406_1596650921102.jpg...",
            "updatedAt": "2020-08-05T18:08:40.700Z",
            "face": {
                "faceId": "9ed162b3-1f39-4b76-9843-084bbf019a94",
                "imageId": "b8b53277-9406-3089-9753-80f06e393611",
                "privateFacesetId": "5d65674cc4458a0007add467",
                "confidence": 100
            }
        },
        {
            "similarity": 99.66107177734375,
            "_id": "5d556732c4878a0007afd487",
            "createdAt": "2020-08-05T18:08:40.700Z",
            "cpf": "00000000000",
            "description": "Imagem...",
            "image": "https://caf-83724234d9-43d-4447-8c6-0b123fd73.s3.amazonaws.com/private_faceset_5f56f09852147700014f406_1597164343555.jpg...",
            "updatedAt": "2020-08-05T18:08:40.700Z",
            "face": {
                "faceId": "029d7b3d-42e6-41ca-ae5d-fddb370cc8b8",
                "imageId": "7aa0a279-cc78-39e6-80ae-622f95c5488c",
                "privateFacesetId": "5d556732c4878a0007afd487",
                "confidence": 99.99410247802734
            }
        }
    ]
}
← Consultar lista de execuçõesWebhooks →