Update a shareholder relation

curl --request PATCH \
  --url https://api.syntage.com/shareholders/{shareholderId}/relations/{relationId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "shares": 1500.5
}
'

{
  "id": "82cd9012-3456-7890-abcd-ef1234567890",
  "link": "/entities/91ab5678-1234-5678-9abc-def012345678",
  "shareholder": {
    "id": "91ab5678-1234-5678-9abc-def012345678",
    "name": "JUAN MANUEL PEREZ GONZALEZ",
    "type": "physical",
    "rfc": "PEIC211118IS0",
    "relations": "<array>",
    "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"
  },
  "relationType": "shareholders",
  "sources": [
    {
      "id": "73de0123-4567-8901-bcde-f23456789012",
      "relation": "<unknown>",
      "shareholder": {
        "id": "91ab5678-1234-5678-9abc-def012345678",
        "name": "JUAN MANUEL PEREZ GONZALEZ",
        "type": "physical",
        "rfc": "PEIC211118IS0",
        "relations": "<array>",
        "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"
      },
      "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"
}

PATCH

shareholders

{shareholderId}

relations

{relationId}

Update a shareholder relation

curl --request PATCH \
  --url https://api.syntage.com/shareholders/{shareholderId}/relations/{relationId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "shares": 1500.5
}
'

{
  "id": "82cd9012-3456-7890-abcd-ef1234567890",
  "link": "/entities/91ab5678-1234-5678-9abc-def012345678",
  "shareholder": {
    "id": "91ab5678-1234-5678-9abc-def012345678",
    "name": "JUAN MANUEL PEREZ GONZALEZ",
    "type": "physical",
    "rfc": "PEIC211118IS0",
    "relations": "<array>",
    "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"
  },
  "relationType": "shareholders",
  "sources": [
    {
      "id": "73de0123-4567-8901-bcde-f23456789012",
      "relation": "<unknown>",
      "shareholder": {
        "id": "91ab5678-1234-5678-9abc-def012345678",
        "name": "JUAN MANUEL PEREZ GONZALEZ",
        "type": "physical",
        "rfc": "PEIC211118IS0",
        "relations": "<array>",
        "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"
      },
      "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"
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

shareholderId

string<uuid>

required

The shareholder ID

relationId

string<uuid>

required

The relation ID

Body

application/json

number<float>

required

The number of shares owned by the shareholder

Required range: x >= 0.01

Example:

1500.5

Response

Shareholder Relation updated successfully

string<uuid>

required

Example:

"82cd9012-3456-7890-abcd-ef1234567890"

link

string<iri-reference>

required

Entity link

Example:

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

shareholder

object

required

Show child attributes

shareholder.id

string<uuid>

required

Example:

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

shareholder.name

string

required

Shareholder name

Example:

"JUAN MANUEL PEREZ GONZALEZ"

shareholder.type

enum<string>

required

Shareholder type

Available options:

physical,

legal,

unknown

Example:

"physical"

shareholder.rfc

string

required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

shareholder.relations

array

required

Shareholder relations with entities

shareholder.entity

string<iri-reference> | null

required

Associated entity

Example:

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

shareholder.createdAt

string

required

Date and time the resource was created

Example:

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

shareholder.updatedAt

string

required

Date and time the resource was last updated

Example:

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

shareholder.@id

string<iri-reference>

Shareholder IRI reference

Example:

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

shareholder.@type

string

default:Shareholder

relationType

enum<string>

required

Type of relation between shareholder and entity

Available options:

shareholders,

shareholder_of

Example:

"shareholders"

sources

object[]

required

Sources of this shareholder relation

Show child attributes

sources.id

string<uuid>

required

Example:

"73de0123-4567-8901-bcde-f23456789012"

sources.relation

any

required

sources.shareholder

object

required

Show child attributes

sources.shareholder.id

string<uuid>

required

Example:

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

sources.shareholder.name

string

required

Shareholder name

Example:

"JUAN MANUEL PEREZ GONZALEZ"

sources.shareholder.type

enum<string>

required

Shareholder type

Available options:

physical,

legal,

unknown

Example:

"physical"

sources.shareholder.rfc

string

required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

sources.shareholder.relations

array

required

Shareholder relations with entities

sources.shareholder.entity

string<iri-reference> | null

required

Associated entity

Example:

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

sources.shareholder.createdAt

string

required

Date and time the resource was created

Example:

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

sources.shareholder.updatedAt

string

required

Date and time the resource was last updated

Example:

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

sources.shareholder.@id

string<iri-reference>

Shareholder IRI reference

Example:

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

sources.shareholder.@type

string

default:Shareholder

sources.sourceName

enum<string>

required

Source of the shareholder information

Available options:

manual,

rpc_socio

Example:

"manual"

sources.sourceId

string<uuid>

required

ID of the source that provided this information

Example:

"64ef1234-5678-9012-cdef-345678901234"

sources.shares

number<float>

required

Number of shares from this source

Example:

1500.5

sources.createdAt

string

required

Date and time the resource was created

Example:

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

sources.updatedAt

string

required

Date and time the resource was last updated

Example:

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

sources.@id

string<iri-reference>

ShareholderRelationsSource IRI reference

Example:

"/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources/73de0123-4567-8901-bcde-f23456789012"

sources.@type

string

default:ShareholderRelationsSource

number<float>

required

Number of shares owned

Example:

1500.5

totalShares

number<float> | null

required

Total number of shares in the company

Example:

10000

ownership

number<float> | null

required

Percentage of the company that is owned

Example:

0.15

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>

ShareholderRelation IRI reference

Example:

"/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890"

@type

string

default:ShareholderRelation

Get a specific shareholder relation Delete a shareholder relation

⌘I

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

Miscellaneous

Update a shareholder relation

Authorizations

Path Parameters

Body

Response