List Dict key
GET {{baseUrl}}/{{version}}/dict-key
Get a list of the DICT Keys you own (or have owned) in chunks of at most 100. If you need smaller chunks, use the limit parameter.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
cursor | null | String used to get the next batch of results. Our SDKs handle this for you. | |
limit | null | Number of results per cursor. Max = 100. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
status | null | Filter dicts by the specified status. | |
type | null | DICT Key type. Options are: "cpf", "cnpj", "phone", "email" or "evp". | |
ids | null | List of strings to get specific entities by ids. | |
fields | null | List of strings to filter response JSON keys. Not available in the SDKs. |
RESPONSES
status: OK
{"cursor":null,"keys":[{"status":"registered","accountNumber":"6341320293482496","ownerType":"legalPerson","taxId":"20.018.183/0001-80","owned":"2020-10-26T17:45:34.671424+00:00","accountType":"checking","branchCode":"0001","ispb":"20018183","name":"Stark Bank S.A.","created":"2020-10-26T17:45:34.671424+00:00","id":"35719950-ac93-4bab-8ad6-56d7fb63afd2","type":"evp","accountCreated":"2020-03-23T23:39:15.257214+00:00"}]}