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.
List of IDs to be retrieved with a list of keys for each ID. Only one key per ID is necessary to identify it on the server.
Array of objects (RequestId) List of IDs to be retrieved with a list of keys. |
{- "ids": [
- {
- "id": "821C51EA-73A7-4AEE-A0F5-0E47373F7151",
- "keys": [
- {
- "key": "pguid",
- "value": "821C51EA-73A7-4AEE-A0F5-0E47373F7151"
}, - {
- "key": "cpf",
- "value": "24614048870"
}, - {
- "key": "rg",
- "value": "170864145"
}
]
}
]
}{- "ids": [
- {
- "id": "821C51EA-73A7-4AEE-A0F5-0E47373F7151",
- "biographics": [
- {
- "key": "name",
- "type": "TEXT",
- "value": "John"
}, - {
- "key": "surname",
- "type": "TEXT",
- "value": "Doe"
}
]
}
]
}Update list of biographics for a provided ID using ID keys.
List of keys to identify an ID and list of biographics to update it with.
Array of objects (RequestKey) | |
Array of objects (Biographic) |
{- "keys": [
- {
- "key": "cpf",
- "value": "12170778802"
}
], - "biographics": [
- {
- "key": "name",
- "type": "TEXT",
- "value": "John"
}
]
}{- "status": 201,
- "message": "Created"
}