Skip to main content
POST
/
entities
/
{entityId}
/
shareholders
Create a new shareholder for an entity
curl --request POST \
  --url https://api.syntage.com/entities/{entityId}/shareholders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "relationType": "shareholders",
  "name": "JUAN MANUEL PEREZ GONZALEZ",
  "shares": 1500.5,
  "rfc": "PEIC211118IS0"
}
'
{
  "id": "91ab5678-1234-5678-9abc-def012345678",
  "name": "JUAN MANUEL PEREZ GONZALEZ",
  "type": "physical",
  "rfc": "PEIC211118IS0",
  "relations": [
    {
      "id": "82cd9012-3456-7890-abcd-ef1234567890",
      "link": "/entities/91ab5678-1234-5678-9abc-def012345678",
      "shareholder": "<unknown>",
      "relationType": "shareholders",
      "sources": [
        {
          "id": "73de0123-4567-8901-bcde-f23456789012",
          "relation": "<unknown>",
          "shareholder": "<unknown>",
          "sourceName": "manual",
          "sourceId": "64ef1234-5678-9012-cdef-345678901234",
          "shares": 1500.5,
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z",
          "@id": "/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources/73de0123-4567-8901-bcde-f23456789012",
          "@type": "ShareholderRelationsSource"
        }
      ],
      "shares": 1500.5,
      "totalShares": 10000,
      "ownership": 0.15,
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z",
      "@id": "/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890",
      "@type": "ShareholderRelation"
    }
  ],
  "entity": "/entities/91ab5678-1234-5678-9abc-def012345678",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z",
  "@id": "/shareholders/91ab5678-1234-5678-9abc-def012345678",
  "@type": "Shareholder"
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
entityId
string<uuid>
required

Body

application/json
​
relationType
enum<string>
required

Direction of the ownership relation to create

Available options:
shareholders,
shareholder_of
Example:

"shareholders"

​
name
string
required

Name of the shareholder to add

Example:

"JUAN MANUEL PEREZ GONZALEZ"

​
shares
number<float>
required

Number of shares represented by the relation

Required range: x >= 0.01
Example:

1500.5

​
rfc
string

Shareholder RFC, when available

Required string length: 12 - 13
Example:

"PEIC211118IS0"

Response

Shareholder created successfully

​
id
string<uuid>
required

Unique shareholder ID

Example:

"91ab5678-1234-5678-9abc-def012345678"

​
name
string
required

Name of the person or company that owns shares

Example:

"JUAN MANUEL PEREZ GONZALEZ"

​
type
enum<string>
required

Shareholder type, where physical is a person, legal is a company, and unknown means the type cannot be determined

Available options:
physical,
legal,
unknown
Example:

"physical"

​
rfc
string
required

Shareholder RFC, when available

Required string length: 12 - 13
Example:

"PEIC211118IS0"

​
relations
object[]
required

Relations that connect this shareholder to entities

​
entity
string<iri-reference> | null
required

Entity created for this shareholder after promotion, if the shareholder has been promoted

Example:

"/entities/91ab5678-1234-5678-9abc-def012345678"

​
createdAt
string
required

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string
required

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

​
@id
string<iri-reference>

Shareholder IRI reference

Example:

"/shareholders/91ab5678-1234-5678-9abc-def012345678"

​
@type
string
default:Shareholder