zimpler-developers

KYC

# GET /v4/kyc/:user_id

Endpoint used to retrieve information about a user known to the merchant.

{
    "user_id": "6a734480-a051-4a05-8405-ac2d8f49102f",
    "country_code": "SE",
    "national_identification_number": "19810101-0000",
    "first_name": "Henrik Testperson",
    "last_name": "Testson",
    "date_of_birth": "1981-01-01",
    "pep": false,
    "address": {
      "line_1": "Box 1529 / Prod Utv",
      "line_2": null,
      "postcode": "17229",
      "city": "Sundbyberg",
      "country": "Sweden"
    },
    "bank_account": {
      "type": "national-SE",
      "bic": "NDEASESS",
      "clearing_number": "3410",
      "account_number": "xxx12",
    }
}

# POST /v4/kyc

Endpoint used to register a new user by providing KYC information about the user.

Notes:

NOTE: POST - KYC is not allowed for deposits but can in certain instances upon agreement be used for withdrawals

# Request SE 

{
// one of
    "national_identification_number": "19810101-0000",
    "date_of_birth": "1981-01-01",
// required
    "country_code": "SE",
    "first_name": "Henrik Testperson",
    "last_name": "Testson",
    "address": {
      "line_1": "Box 1529 / Prod Utv",
      "line_2": null,
      "postcode": "17229",
      "city": "Sundbyberg",
      "country": "Sweden"
    }
}

# Request FI 

{
// one of
    "national_identification_number": "131052-308T",
    "date_of_birth": "1952-10-13",
// required
    "country_code": "FI",
    "first_name": "Henrik Testperson",
    "last_name": "Testson",
    "address": {
      "line_1": "Box 1529 / Prod Utv",
      "line_2": null,
      "postcode": "17229",
      "city": "Sundbyberg",
      "country": "Finland"
    }
}

# Response

All responses will include the full kyc object sent within your request. This is pointed out with the […] in below documentation.

{
    ...
    "user_id": "6a734480-a051-4a05-8405-ac2d8f49102f"
}

# PUT /v4/kyc/:user_id

Endpoint used to update a existing user by providing new KYC information about the user.

NOTE: this will only work for users posted in the kyc post endpoint.

# Request 

{
// one of (same as in post)
    "national_identification_number": "19810101-0000",
    "date_of_birth": "1981-01-01",
// required
    "country_code": "SE",
    "first_name": "Henrik Updated",
    "last_name": "Testson",
    "address": {
      "line_1": "Box 1529 / Prod Utv",
      "line_2": null,
      "postcode": "17230",
      "city": "Sundby",
      "country": "Sweden"
    }
}

# Response 

{
    ...
}