IdentityDto

An identity graph. SOAP equivalent: ACPO_Identity.

identityIdinteger<int32>required

externIdinteger<int32>required

externKeystringnullable

namestringnullable

firstNamestringnullable

birthDatestring<date-time>required

appellationIdinteger<int32>required

siretstringnullable

identityCategoryinteger<int32>required

languageIdinteger<int32>required

idCardNumberstringnullable

familystringnullable

identityTypestringnullable

favoriteTeamstringnullable

isContactDefaultbooleanrequired

addresses object[]nullable

Array [

addressIdinteger<int32>required

address1stringnullable

address2stringnullable

address3stringnullable

address4stringnullable

zipCodestringnullable

citystringnullable

countrystringnullable

isDefaultbooleanrequired

typestringnullable

]

communications object[]nullable

Array [

communicationIdinteger<int32>required

communicationTypeIdinteger<int32>required

communicationLabelIdinteger<int32>required

communicationLabelstringnullable

communicationValuestringnullable

isDefaultbooleanrequired

]

optins object[]nullable

Array [

propertyIdinteger<int32>required

labelstringnullable

dataTypestringnullable

valueBooleanbooleanrequired

valueLabelstringnullable

valueDateTimestring<date-time>required

]

populationsAffected object[]nullable

Array [

idinteger<int32>required

Population property identifier (SOAP: ID).

labelstringnullable

Population label.

codestringnullable

Population code.

optionalstringnullable

Optional value (always empty).

validityDateStartstring<date-time>required

Validity start date.

validityDateEndstring<date-time>required

Validity end date.

rights object[]nullable

Rights granted to the population.

Array [

objectTypeRightstringnullable

Type of the right object (SOAP: ObjectTypeRight).

rightObjectIdinteger<int32>required

Identifier of the right object (SOAP: ID_RightObject).

valueinteger<int32>required

Right value (always 1).

]

]

mergedIdsinteger<int32>[]nullable

contactsundefined[]nullable

IdentityDto

{
  "identityId": 0,
  "externId": 0,
  "externKey": "string",
  "name": "string",
  "firstName": "string",
  "birthDate": "2024-07-29T15:51:28.071Z",
  "appellationId": 0,
  "siret": "string",
  "identityCategory": 0,
  "languageId": 0,
  "idCardNumber": "string",
  "family": "string",
  "identityType": "string",
  "favoriteTeam": "string",
  "isContactDefault": true,
  "addresses": [
    {
      "addressId": 0,
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "address4": "string",
      "zipCode": "string",
      "city": "string",
      "country": "string",
      "isDefault": true,
      "type": "string"
    }
  ],
  "communications": [
    {
      "communicationId": 0,
      "communicationTypeId": 0,
      "communicationLabelId": 0,
      "communicationLabel": "string",
      "communicationValue": "string",
      "isDefault": true
    }
  ],
  "optins": [
    {
      "propertyId": 0,
      "label": "string",
      "dataType": "string",
      "valueBoolean": true,
      "valueLabel": "string",
      "valueDateTime": "2024-07-29T15:51:28.071Z"
    }
  ],
  "populationsAffected": [
    {
      "id": 0,
      "label": "string",
      "code": "string",
      "optional": "string",
      "validityDateStart": "2024-07-29T15:51:28.071Z",
      "validityDateEnd": "2024-07-29T15:51:28.071Z",
      "rights": [
        {
          "objectTypeRight": "string",
          "rightObjectId": 0,
          "value": 0
        }
      ]
    }
  ],
  "mergedIds": [
    0
  ],
  "contacts": [
    null
  ]
}