{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9e4ffa63-48d5-4e21-9a9d-dc05255cc60d","name":"Passportscan Cloud API   (Pubblic for external integrator)","description":"The purpose of this API is to be able to interact with the data collected in the check-in process from our application, whether in android, ios or windows format.  \nFor this we provide some calls that we have tried to make them as accessible and easy as possible.\n\nWith this API you can manage everything related to reservations and customers. You will be able to upload incomplete reservations, which will be shown in our APP and carry out the entire checkin process with the reservation data to later collect that reservation with all the necessary data completed, or create them from the APP and collect them later\n\n# Overview\n\nAll data will be sent and received in JSON format.  \nGender format is \"10\" for Male and \"20\" for female.  \nAll country fields will be in ISO3 format.\n\nThe data is only overwritten if when a field is sent, this field has some value, in any other case the data already inserted will prevail.\n\nAll date fields will have the format “YYYY-MM-DD” example: 1879-03-14.\n\nThe codes of the types of documents accepted today are:\n\n- IDC for the identity document\n    \n- PAS for the passport\n    \n- DRI for the driving license\n    \n- EXT for unrecognized documents\n    \n\nIn both requests and responses there are several fields to consider. \"reservation_id\" is our internal identification field for the reservation, this field is only consultative, in the same way, the fields \"id\" or \"guest_id\" depending on where they appear, are our internal fields that identify customers and are also consultative.\n\nHow can I do to relate the previous internal fields with those of each Product? For reservations, the field is \"pms_reservation_id\" and for customers it is \"pms_guest_id\".\n\nThis means that you have to set these fields with the data with the identifiers of your program. Example, for our reservation number 34, it would correspond to your reservation \"BOOK674\", the procedure would be \"reservation_id\" = 34, \"pms_reservation_id\" = \"BOOK674\"\n\n# Authentication\n\nThe authentication will use Bearer tokens and will be carried out with the function expressed below. When the token expires, the refresh token function will have to be called.\n\nTest keys and a demo endpoint are provided, but the keys to use in production will be sent by us once the validation and verification period as an integrator has ended for the product in question\n\n# **URL Call-back (**Highly recommended**)**\n\nBy setting a Callback URL in the Branch settings of PassportScan Cloud, you will activate a callback system that sends a notification to your URL whenever a guest profile or check-in reservation is modified.\n\nExample callback JSON payload:\n\n{  \n\"action\": \"update\",  \n\"guest_id\": 154354,  \n\"guest_uuid\": \"9a361d6a-fd68-41cc-ba72-2345950914b9\",  \n\"hotel_id\": \"e20f1af8\",  \n\"reservation_id\": 8786,  \n\"reservation_uuid\": \"2fed52bf-7d3c-4ae2-a887-4273b9b2586e\"  \n}\n\nThe hotel_id corresponds to the first 8 characters of the public key and uniquely identifies the hotel.\n\nThis payload is an example of the notification sent to your specified Callback URL whenever changes occur.\n\nEndFragment\n\n# Error Codes\n\nAll error responses will have JSON format where there will be a field called \"code\" that will say the error code and a \"message\" field with associated information\n\n# Standard workflow to implement PassportScan Cloud into your PMS\n\n<img src=\"https://content.pstmn.io/6ff5a6e4-2995-4401-9e58-120dbb5a7f73/aW1hZ2UucG5n\" width=\"948\" height=\"533\">","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2963177","team":1061614,"collectionId":"9e4ffa63-48d5-4e21-9a9d-dc05255cc60d","publishedId":"2s8Yemttug","public":true,"publicUrl":"https://documenter-api.postman.tech/view/2963177/2s8Yemttug","privateUrl":"https://go.postman.co/documentation/2963177-9e4ffa63-48d5-4e21-9a9d-dc05255cc60d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"433e5c"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-11-10T11:35:57.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/97c346b9e417512dd999bc63b1dee98a972a0e214d420395c45e27f2134d2eb0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s8Yemttug"}