Biographic

External biographics from a biographic database.

listBiographics

post

Provide a list of one or more IDs and, for each ID provided, retrieve a list of biographics from an external biographic database using ID keys.

If the authorization token is VALID, the response will be 200 OK. It will contain an ID list with the related biographics. If no IDs are found, the return is an empty list.

If the authorization token is INVALID, the response will be 403 Forbidden.

Required scopes

This endpoint requires the following scopes:

• : get biographics

Authorizations

biographic_auth

OAuth2implicitRequired

Authorization URL:

Body

application/json

Responses

200

OK

application/json

403

Forbidden

post

/biographics

HTTPcURLJavaScriptPython

POST /biographicBase/biographics HTTP/1.1
Host: <ip>:8130
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 196

{
  "ids": [
    {
      "id": "821C51EA-73A7-4AEE-A0F5-0E47373F7151",
      "keys": [
        {
          "key": "pguid",
          "value": "821C51EA-73A7-4AEE-A0F5-0E47373F7151"
        },
        {
          "key": "cpf",
          "value": "24614048870"
        },
        {
          "key": "rg",
          "value": "170864145"
        }
      ]
    }
  ]
}

Single IDMultiple IDs

{
  "ids": [
    {
      "id": "821C51EA-73A7-4AEE-A0F5-0E47373F7151",
      "biographics": [
        {
          "key": "name",
          "type": "TEXT",
          "value": "John"
        },
        {
          "key": "surname",
          "type": "TEXT",
          "value": "Doe"
        }
      ]
    }
  ]
}

updateBiographics

put

Update list of biographics for a provided ID using ID keys.

Body

application/json

An ID identified with a list of keys and list to biographics to update it with.

Responses

201

If no ID is found by keys, CREATE it on the biographic base.

application/json

Status of update operation

statusinteger · enumOptional

HTTP status

Possible values:

messagestring · enumOptional

Status message

Possible values:

202

If an ID is found by keys, UPDATE it on the biographic base.

application/json

403

Forbidden

put

/biographics

HTTPcURLJavaScriptPython

PUT /biographicBase/biographics HTTP/1.1
Host: <ip>:8130
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "keys": [
    {
      "key": "cpf",
      "value": "12170778802"
    }
  ],
  "biographics": [
    {
      "key": "name",
      "type": "TEXT",
      "value": "John"
    }
  ]
}

{
  "status": 201,
  "message": "Created"
}