These routes are publicly available routes to the version 5 API of the Customer Care Center.
\nValid Status codes for these routes are as follows:
\nNo other status codes should be expected for these routes.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Status Codes","slug":"status-codes"}],"owner":"35176476","collectionId":"79f25bca-3ca3-4434-8e3d-799291404e47","publishedId":"2sA3e2eopT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-08T22:09:36.000Z"},"item":[{"name":"Access Key API Routes","item":[{"name":"Email Checker","item":[{"name":"Query Email Checker","id":"a6a636a5-5d73-4ac9-94d8-8b5ba5dec247","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v5/emailchecker?email=demo@domain.com","description":"Check if a provided email address can be reserved on the system.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Gwis-Access-Key"},{"key":"value","value":"prefix.secretkey"}]},"isInherited":true,"source":{"_postman_id":"8088f35d-46a4-4bc8-80b0-bf8d5466a735","id":"8088f35d-46a4-4bc8-80b0-bf8d5466a735","name":"Access Key API Routes","type":"folder"}},"urlObject":{"path":["v5","emailchecker"],"host":["{{url}}"],"query":[{"key":"email","value":"demo@domain.com"}],"variable":[]}},"response":[{"id":"a20e9989-9d50-4f5e-8600-763bf2a4e78d","name":"Query Email Checker - False","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v5/emailchecker?email=demo@domain.com","host":["{{url}}"],"path":["v5","emailchecker"],"query":[{"key":"email","value":"demo@domain.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Jun 2020 17:34:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept, Origin, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE, OPTIONS"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Cache-Control","value":"post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"success\": true,\n \"data\": {\n \"available\": false,\n \"message\": \"Address cannot be reserved\",\n \"email\": \"demo@domain.com\"\n }\n}"},{"id":"0618ff66-146b-458d-9e2c-2e85bc6b6ba7","name":"Query Email Checker - True","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v5/emailchecker?email=demo@domain.com","host":["{{url}}"],"path":["v5","emailchecker"],"query":[{"key":"email","value":"demo@domain.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Jun 2020 17:39:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept, Origin, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE, OPTIONS"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Cache-Control","value":"post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"success\": true,\n \"data\": {\n \"available\": true,\n \"message\": \"Address can be reserved\",\n \"email\": \"demo@domain.com\"\n }\n}"}],"_postman_id":"a6a636a5-5d73-4ac9-94d8-8b5ba5dec247"},{"name":"Reserve Email","id":"fe825dcb-8234-4ba9-8c27-ee652021f7ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"demo@domain.com\",\r\n \"name\": \"Tom Hanks\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v5/emailchecker","description":"Reserve an email address for a specified name.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Gwis-Access-Key"},{"key":"value","value":"prefix.secretkey"}]},"isInherited":true,"source":{"_postman_id":"8088f35d-46a4-4bc8-80b0-bf8d5466a735","id":"8088f35d-46a4-4bc8-80b0-bf8d5466a735","name":"Access Key API Routes","type":"folder"}},"urlObject":{"path":["v5","emailchecker"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"587fce87-e0f7-4b04-813c-20866fb241cf","name":"Reserve Email - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"demo@domain.com\",\r\n \"name\": \"Tom Hanks\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v5/emailChecker"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Jun 2020 20:39:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept, Origin, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE, OPTIONS"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Cache-Control","value":"post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"success\": true,\n \"data\": {\n \"id\": 12,\n \"ispId\": 7,\n \"email\": \"demo@domain.com\",\n \"name\": \"Tom Hanks\",\n \"status\": \"reserved\",\n \"updated\": \"2020-06-08T20:39:51Z\",\n \"created\": \"2020-06-08T20:39:51Z\"\n }\n}"},{"id":"22752015-569f-4b6e-bdbc-6cbb87f8ed8b","name":"Reserve Email - Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"demo@domain.com\",\r\n \"name\": \"Tom Hanks\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v5/emailChecker"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Jun 2020 20:40:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept, Origin, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE, OPTIONS"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Cache-Control","value":"post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"success\": true,\n \"data\": {\n \"available\": false,\n \"message\": \"Address already used or reserved.\",\n \"email\": \"demo@domain.com\"\n }\n}"}],"_postman_id":"fe825dcb-8234-4ba9-8c27-ee652021f7ca"}],"id":"0a5672f3-c1e2-4c24-b4d4-aec87cf77ab8","description":"The EmailChecker routes are used to check the availability of a specific email address and mark it as reserved if it is available.
\nRequests to these routes are subject to rate limiting and source based IP access control. Please contact Golden West support if you need an IP address added to the access list.
\nRequests to these routes are limited to 30 requests per minute.
\n","event":[{"listen":"prerequest","script":{"id":"8e1b2836-a884-4985-b6c5-5a78decb18f8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6b74923-50c8-44ec-ad78-c1613b2c499a","type":"text/javascript","exec":[""]}}],"_postman_id":"0a5672f3-c1e2-4c24-b4d4-aec87cf77ab8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Gwis-Access-Key"},{"key":"value","value":"prefix.secretkey"}]},"isInherited":true,"source":{"_postman_id":"8088f35d-46a4-4bc8-80b0-bf8d5466a735","id":"8088f35d-46a4-4bc8-80b0-bf8d5466a735","name":"Access Key API Routes","type":"folder"}}}],"id":"8088f35d-46a4-4bc8-80b0-bf8d5466a735","description":"Routes inside this folder require the use of an API key provided by Golden West. This key must be added to the headers of every request under the name Gwis-Access-Key
Example Header
\nGwis-Access-Key: 123456789.abcdefghijklmnopqrstuvwxyz1234567890\nThe Ping route is used to verify the API is available and ready to service requests.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"63fe9bcb-cb2c-4895-ad89-819c28858c2a","id":"63fe9bcb-cb2c-4895-ad89-819c28858c2a","name":"No Auth Routes","type":"folder"}},"urlObject":{"path":["v5","ping"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4f7d901d-60d8-4f02-bb11-990bd16a7085","name":"Ping","originalRequest":{"method":"GET","header":[],"url":"{{url}}/v5/ping"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Jun 2020 22:16:12 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept, Origin, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE, OPTIONS"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"success\": true,\n \"data\": {\n \"message\": \"Roger, Roger!\"\n }\n}"}],"_postman_id":"ee616725-b89a-4272-b5b6-b7518be8d0b7"}],"id":"4d6f79b2-6340-4715-a618-47a040a123e7","description":"System specific routes.
\n","_postman_id":"4d6f79b2-6340-4715-a618-47a040a123e7","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"63fe9bcb-cb2c-4895-ad89-819c28858c2a","id":"63fe9bcb-cb2c-4895-ad89-819c28858c2a","name":"No Auth Routes","type":"folder"}}}],"id":"63fe9bcb-cb2c-4895-ad89-819c28858c2a","description":"Routes in this folder do not require any specific authentication methods.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"63fe9bcb-cb2c-4895-ad89-819c28858c2a"}],"event":[{"listen":"prerequest","script":{"id":"d4ef6ca5-28d8-4374-9398-4cd772cada52","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"14d1d64e-7997-4ffd-a91e-6ab98d9c6362","type":"text/javascript","exec":[""]}}],"variable":[{"key":"keyName","value":"Gwis-Access-Key"},{"key":"accessKey","value":"prefix.secretkey"}]}