Skip to main content

Endpoint

POST /v1/parsers

Authentication

Requires parsers:write permission.

Request Body

FieldTypeRequiredDescription
verticalstringYesTarget vertical: healthcare, banking, emergency, logistics, telecom, gov
namestringYesHuman-readable name
descriptionstringNoOptional description
schemaarrayYesArray of field definitions (max 50)

Field definition

FieldTypeRequiredDescription
idstringYesUnique field identifier
namestringYesField name
sms_codestringYesShort code for SMS encoding (max 8 chars)
typestringYesstring, number, boolean, gps, text, timestamp, enum, phone, email, address, hardware_id
requiredbooleanYesWhether the field is mandatory
enabledbooleanYesWhether the field is active
offline_capablebooleanYesWhether the field is transmitted offline via SMS
sectionstringYescore, location, human, hardware, team, custom
max_bytesnumberYesMaximum bytes for SMS encoding (1-160)
enum_valuesarrayNoRequired when type is enum
legalbooleanNoMarks the field as containing PII

Response

Returns the created parser with id, version and created_at.