NTAK Check-in event

On this page, we will explore the process of programmatically constructing the VIZA check-in report. We will delve into the steps and techniques required to build the report dynamically through code.

Request

curl -X POST https://api.ntak.guru/v1/accommodations/99845d23-7ffb-4267-85ef-c8d4ac70e46a/reports/viza/check_in \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"occurredAt":"1996-02-20 23:40:49","guests":[{"id":"aa44181d-de4d-3d75-95e2-229b5c8ed753","arrival":"2000-03-06 10:02:11","departure":"2000-03-12","manual":{"firstName":"Florian","lastName":"Price","birthFirstName":"Mylene","birthLastName":"Trantow","dateOfBirth":"1972-01-01","placeOfBirth":"New Leilaniburgh","motherFirstName":"Vicenta","motherLastName":"Lesch","nationality":"LV","gender":"male","documentType":"driving_license","documentNumber":"9441083532"},"scanned":{"firstName":"Chad","lastName":"Wisoky","birthFirstName":"Kiarra","birthLastName":"Ernser","dateOfBirth":"2001-11-19","placeOfBirth":"North Reed","motherFirstName":"Lucy","motherLastName":"Simonis","nationality":"NZ","gender":"female","documentType":"other","documentNumber":"4355014418"},"visaNumber":"5682809016","visaDateOfEntry":"2020-11-01","visaPlaceOfEntry":"Port Hardyland"}]}'

URL Parameters

Request body

occurredAt

Date of the event.

guests

The guests who check in to the accommodation. Minimum 1 guest.

• id

  The unique identifier of the guest.
  This ID must be used in the check out report.

  Type	Required
  uuid	Yes

• arrival

  The date and time of the arrival of the guest.

  Type	Format	Required
  string	Y-m-d H:i:s UTC	Yes

• departure

  The planned departure time of the guest.

  Type	Format	Required
  string	Y-m-d	Yes

• scanned

  The scanned document of the guest.

  ℹ️

  VIZA expects all fields that the scanner could scan from the document to filled out.

  The scanned data mist be filled in here without any modification.
  Except the nationality, gender and document type, which have predefined values.

  Type	Required
  object	Yes

  • firstName

    First name of the guest.

    Type	Required
    string	Yes

  • lastName

    Last name of the guest.

    Type	Required
    string	Yes

  • birthFirstName

    Birth first name of the guest.

    Type	Required
    string	If it's on the document

  • birthLastName

    Birth last name of the guest.

    Type	Required
    string	If it's on the document

  • dateOfBirth

    Date of birth of the guest.

    Type	Format	Required
    string	Y-m-d	If it's on the document

  • placeOfBirth

    Place of birth of the guest.

    Type	Required
    string	If it's on the document

  • motherFirstName

    Mother first name of the guest.

    Type	Required
    string	If it's on the document

  • motherLastName

    Mother last name of the guest.

    Type	Required
    string	If it's on the document

  • nationality

    Nationality of the guest.

    Type	Format	Required
    string	ISO 3166-1 alpha-2 (opens in a new tab) code	If it's on the document

  • gender

    Gender of the guest.

    Type	Required
    Gender	If it's on the document

  • documentType

    Document type of the guest.

    Type	Required
    Document type	Yes

  • documentNumber

    Document number of the guest.

    Type	Required
    string	Yes

• manual

  The modified guest information.

  ℹ️

  We highly recommend that you should send every field that you have filled in the scanned document, even if it wasn't modified.

  We'll make sure unmodified fields won't be in the report.

  Type	Required
  object	Yes

  • firstName

    First name of the guest.

    Type	Required
    string	Yes

  • lastName

    Last name of the guest.

    Type	Required
    string	Yes

  • birthFirstName

    Birth first name of the guest.

    Type	Required
    string	If it's on the document

  • birthLastName

    Birth last name of the guest.

    Type	Required
    string	If it's on the document

  • dateOfBirth

    Date of birth of the guest.

    Type	Format	Required
    string	Y-m-d	If it's on the document

  • placeOfBirth

    Place of birth of the guest.

    Type	Required
    string	If it's on the document

  • motherFirstName

    Mother first name of the guest.

    Type	Required
    string	If it's on the document

  • motherLastName

    Mother last name of the guest.

    Type	Required
    string	If it's on the document

  • nationality

    Nationality of the guest.

    Type	Format	Required
    string	ISO 3166-1 alpha-2 (opens in a new tab) code	If it's on the document

  • gender

    Gender of the guest.

    Type	Required
    Gender	If it's on the document

  • documentType

    Document type of the guest.

    Type	Required
    Document type	Yes

  • documentNumber

    Document number of the guest.

    Type	Required
    string	Yes

• visaNumber

  Visa number of the guest.

  Type	Required
  string	If it's relevant

• visaDateOfEntry

  Date of the visa entry.

  Type	Format	Required
  string	Y-m-d	If it's relevant

• visaPlaceOfEntry

  Place of the visa entry.

  Type	Required
  string	If it's relevant

{
  "occurredAt": "1996-02-20 23:40:49",
  "guests": [
    {
      "id": "aa44181d-de4d-3d75-95e2-229b5c8ed753",
      "arrival": "2000-03-06 10:02:11",
      "departure": "2000-03-12",
      "manual": {
        "firstName": "Florian",
        "lastName": "Price",
        "birthFirstName": "Mylene",
        "birthLastName": "Trantow",
        "dateOfBirth": "1972-01-01",
        "placeOfBirth": "New Leilaniburgh",
        "motherFirstName": "Vicenta",
        "motherLastName": "Lesch",
        "nationality": "LV",
        "gender": "male",
        "documentType": "driving_license",
        "documentNumber": "9441083532"
      },
      "scanned": {
        "firstName": "Chad",
        "lastName": "Wisoky",
        "birthFirstName": "Kiarra",
        "birthLastName": "Ernser",
        "dateOfBirth": "2001-11-19",
        "placeOfBirth": "North Reed",
        "motherFirstName": "Lucy",
        "motherLastName": "Simonis",
        "nationality": "NZ",
        "gender": "female",
        "documentType": "other",
        "documentNumber": "4355014418"
      },
      "visaNumber": "5682809016",
      "visaDateOfEntry": "2020-11-01",
      "visaPlaceOfEntry": "Port Hardyland"
    }
  ]
}

Response

{
  "message": null,
  "payload": {
    "id": "f2e0ed9f-1d99-471e-ab69-e3967cb07801",
    "messageId": "e3ce35b4-4049-494e-bab7-27c703df9c8c",
    "service": "viza",
    "status": "pending",
    "type": "check_in",
    "reason": "Report arrived from PMS",
    "context": {
      "occurredAt": "1996-02-20 23:40:49",
      "guests": [
        {
          "id": "aa44181d-de4d-3d75-95e2-229b5c8ed753",
          "arrival": "2000-03-06 10:02:11",
          "departure": "2000-03-12",
          "manual": {
            "firstName": "Florian",
            "lastName": "Price",
            "birthFirstName": "Mylene",
            "birthLastName": "Trantow",
            "dateOfBirth": "1972-01-01",
            "placeOfBirth": "New Leilaniburgh",
            "motherFirstName": "Vicenta",
            "motherLastName": "Lesch",
            "nationality": "LV",
            "gender": "male",
            "documentType": "driving_license",
            "documentNumber": "9441083532"
          },
          "scanned": {
            "firstName": "Chad",
            "lastName": "Wisoky",
            "birthFirstName": "Kiarra",
            "birthLastName": "Ernser",
            "dateOfBirth": "2001-11-19",
            "placeOfBirth": "North Reed",
            "motherFirstName": "Lucy",
            "motherLastName": "Simonis",
            "nationality": "NZ",
            "gender": "female",
            "documentType": "other",
            "documentNumber": "4355014418"
          },
          "visaNumber": "5682809016",
          "visaDateOfEntry": "2020-11-01",
          "visaPlaceOfEntry": "Port Hardyland"
        }
      ]
    },
    "response": null,
    "createdAt": "2022-11-10T11:10:2700:00",
    "updatedAt": "2022-11-10T11:10:2700:00"
  }
}