POST /v1/entity/name

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service


Path:  /v1/entity/name

Authentication: API Key required, User ID required

Description: upload a name for an entity



Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id ax34er6tt65edr
entity_id string yes The entity ID being manipulated
name string yes the trading name of the entity "Joe the Plumber"
formal_name string no The formal (legal) name of the entity "Plumbers Inc"
branch_name string no Any branch identifier of the entity "Stockton outlet"


Sample Success Response:

    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "379275323781120",
        "rev": "29-f8659797282cbbfffa92c20731486e38"

Docs Navigation