Registers a new person related to a merchant.

Registers a new person related to a merchant.

post/related-people

Request

  • Base URL
    https://api.test.kalixa.com/payment-service/v6
  • URL
    https://api.test.kalixa.com/payment-service/v6/related-people
  • Auth
    HTTP basic

Request body

rolesstring[] required

A list of roles the person holds. See https://developer.kalixa.com/v1.0/docs/mandatory-data-per-cdd-level#section-related-people for more information about conditionally mandatory parameters.

firstnamestring required

The persons first name.

lastnamestring required

The persons last name.

phoneNumberstring

A landline or mobile number where the person can be contacted, including country prefix. Used for contacting this person by PXP Financial if necessary.

dateOfBirthstring

The date of birth of the person. Used for screening purposes by the PXP Financial Risk Team.

skypeNamestring

The skype contact, if available. Used for contacting this person by PXP Financial if necessary.

emailstring

The persons valid email address. Used for contacting this person by PXP Financial if necessary.

shareOrOwnershipPercentagenumber

A percentage amount that indicates the ownership participation of the person. Used for screening purposes by the PXP Financial Risk Team.

merchantIdstring required

The id of the merchant to which this contact relates to. Used for associating the contact with the merchant.

passportOrGovernmentNumberstring

The unique identifier of the persons Passport or government number. Used for screening purposes by the PXP Financial Risk Team.

passportOrGovernmentIDExpirationDatestring

The date when the passport or the government-ID expires. Used for screening purposes by the PXP Financial Risk Team.

isListedOnPEPboolean

The information if the related person is listed on PEP. PEP is short for 'politically exposed person', a natural person who is or who has been entrusted with prominent public functions. Used by the PXP Financial Risk Team.

Example request

{
  "firstname": "Paul",
  "lastname": "Smith",
  "address": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "dateOfBirth": "2020-12-09T09:46:18.645Z",
  "skypeName": "PaulSmith461029",
  "email": "paul.smith@testabc.com",
  "shareOrOwnershipPercentage": 51,
  "merchantId": "f6b4d04e-1a67-4f7b-a6b0-181636af3290",
  "passportOrGovernmentNumber": "1633PY-111Z",
  "passportOrGovernmentIDExpirationDate": "2020-12-09T09:46:18.645Z"
}

Response

Successful operation

idstring

The server-generated id of the person which was registered or returned. Used for identifying the person in other methods e.g. getRelatedPerson.

rolesstring[]

A list of roles the person holds. See https://developer.kalixa.com/v1.0/docs/mandatory-data-per-cdd-level#section-related-people for more information about conditionally mandatory parameters.

firstnamestring

The persons first name.

lastnamestring

The persons last name.

phoneNumberstring

A landline or mobile number where the person can be contacted, including country prefix. Used for contacting this person by PXP Financial if necessary.

dateOfBirthstring

The date of birth of the person. Used for screening purposes by the PXP Financial Risk Team.

skypeNamestring

The skype contact, if available. Used for contacting this person by PXP Financial if necessary.

emailstring

The persons valid email address. Used for contacting this person by PXP Financial if necessary.

shareOrOwnershipPercentagenumber

A percentage amount that indicates the ownership participation of the person. Used for screening purposes by the PXP Financial Risk Team.

passportOrGovernmentNumberstring

The unique identifier of the persons Passport or government number. Used for screening purposes by the PXP Financial Risk Team.

passportOrGovernmentIDExpirationDatestring

The date when the passport or the government-ID expires. Used for screening purposes by the PXP Financial Risk Team.

isListedOnPEPboolean

The information if the related person is listed on PEP. PEP is short for 'politically exposed person', a natural person who is or who has been entrusted with prominent public functions. Used by the PXP Financial Risk Team.

Example response

{
  "id": "357f2e62-0481-4311-8dfb-003562923af1",
  "firstname": "Paul",
  "lastname": "Smith",
  "address": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "skypeName": "PaulSmith461029",
  "email": "paul.smith@testabc.com",
  "shareOrOwnershipPercentage": 51,
  "passportOrGovernmentNumber": "1633PY-111Z",
  "passportOrGovernmentIDExpirationDate": "2020-12-09T09:46:18.645Z",
  "merchant": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "documents": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.