Documentation: customers
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.
Required | Type | p14n | Blurred | Autogenerated | Example | |
---|---|---|---|---|---|---|
external_id Identifies the customer in the context of the data_origin. Can be a fixed ID in another database system or any other way to identify the customer, but note that this information is not encrypted, if you use national id numbers or phone numbers pseudonymize them first. |
✓ | string | ⤫ | ⤫ | ⤫ |
6574 |
uid organization_id + data_origin + external_id; ID for the specific customer |
⤫ | string | ⤫ | ⤫ | ✓ |
1 |
name The full name of the customer (p14) |
⤫ | string | ✓ | ⤫ | ⤫ |
John Smith - stored as 7c6e6899401b76f23d4eaf4931975872f1b5d9ae026b8b8213a25cf7812d936b |
address The customers address (p14) |
⤫ | string | ✓ | ⤫ | ⤫ |
Some Street 123, Example Village - stored as 452a20d7b82bd6ad82f0bf482f382bfe55f90dcb140e1e79d38b15a4450770d7 |
birth_year year of purchaser birth, for demographic analysis Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
⤫ | integer | ⤫ | ⤫ | ⤫ |
2000 |
country A two-letter country code according to ISO 3166-1 alpha-2 |
⤫ | string | ⤫ | ⤫ | ⤫ |
UG |
The customers email address (p14) |
⤫ | string | ✓ | ⤫ | ⤫ |
test@example.com - stored as b37645e1cc4bc50636c11a9a19566f2ae56764333789159dacb171580c42e49b |
former_electricity_source e.g. none, solar, genset |
⤫ | string | ⤫ | ⤫ | ⤫ |
genset |
gender The customers gender, e.g. male, female, other, or unknown (null) |
⤫ | enum: M, F, O | ⤫ | ⤫ | ⤫ |
M |
household_size The number of residents in customers household (only if residential use) Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
⤫ | integer | ⤫ | ⤫ | ⤫ |
4 |
identification_type type of customer identification, eg. national ID, passport, driver license |
⤫ | string | ⤫ | ⤫ | ⤫ |
national ID |
identification_number The identification number of the customers ID document |
⤫ | string | ✓ | ⤫ | ⤫ |
7b1a3d34a3fcbad23308a5da7b49f9f3f7a67d2d |
phone The customers primary phone number (p14) |
⤫ | string | ✓ | ⤫ | ⤫ |
+2560123456789 - stored as a6bff03207824aac531aa0ecfbc5d4597ba4e90c230b35afe60061045bf83f23 |
phone_2 The customers secondary phone number (p14) |
⤫ | string | ✓ | ⤫ | ⤫ |
+2560123456789 - stored as a6bff03207824aac531aa0ecfbc5d4597ba4e90c230b35afe60061045bf83f23 |
profession Profession of customer |
⤫ | string | ⤫ | ⤫ | ⤫ |
farmer |
created_at Timestamp when row was inserted |
⤫ | datetime | ⤫ | ⤫ | ✓ |
2021-05-03 6:23:55 |
updated_at Timestamp when row was updated |
⤫ | datetime | ⤫ | ⤫ | ✓ |
2021-05-03 6:23:55 |
source_id References Source of data |
⤫ | integer | ⤫ | ⤫ | ✓ |
1 |
import_id References Import of data |
⤫ | integer | ⤫ | ⤫ | ✓ |
1 |
organization_id References Organization of data |
⤫ | integer | ⤫ | ⤫ | ✓ |
1 |
custom Saves additional imported data out of standard structure |
⤫ | jsonb | ⤫ | ⤫ | ✓ |
{ "some": "key" } |
data_origin Origin of the data, generic or name of the api |
⤫ | string | ⤫ | ⤫ | ✓ |
generic |
last_import_id Id of the last import which updated the record |
⤫ | integer | ⤫ | ⤫ | ✓ |
337 |
last_source_id Id of the last Source which updated the record |
⤫ | integer | ⤫ | ⤫ | ✓ |
33 |