The Postman Environment is pre-configured to allow you to use the scripts and walk through the Postman Scripts with minimal intervention to aid in understanding the API call structure.
Consumer Credit Postman Collections include pre-defined API calls to help you understand and develop your solution. See the Test API Postman Collection for additional documentation.
- The Consumer Credit - Test API.postman_collection.json includes some webhook tests to help you understand and develop your solution. See the Test API Postman Collection for additional documentation.
- The Consumer Credit - Getting Started - New User.postman_collection.json will walk you through the Create New User steps in order
- The Consumer Credit - Getting Started - Returning User.postman_collection.json will walk you through the Returning User steps in order
- The Consumer Credit - User API.postman_collection.json provides all User-oriented APIs
- The Consumer Credit - Direct API.postman_collection.json will walk you through using the Direct API collection
- The Consumer Credit - EFX API.postman_collection.json has examples for all Equifax APIs
Test APIs: Consumer Credit - Test API.postman_collection.json
{
"info": {
"_postman_id": "ecfa55bb-7382-4439-ae40-8916233c0ed9",
"name": "Consumer Credit - Test API",
"description": "The Consumer Credit - Test API.postman_collection.json includes some webhook tests to help you understand and develop your solution.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "New Pre-auth Token",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var data = pm.response.json();",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/test/preauth-token/{{userId}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"test",
"preauth-token",
"{{userId}}"
]
},
"description": "Quickly create a preauth token for a preexisting user without having to implement the full Direct Authentication API or complete a full user login."
},
"response": []
},
{
"name": "Webhook Test",
"event": [
{
"listen": "test",
"script": {
"exec": [
"//var data = pm.response.json();",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "test",
"type": "string"
},
{
"key": "username",
"value": "test",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/test/webhook/send/{{userId}}?count=1&type=ACCNEW",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"test",
"webhook",
"send",
"{{userId}}"
],
"query": [
{
"key": "count",
"value": "1"
},
{
"key": "type",
"value": "ACCNEW",
"description": "Choose from: ACCNEW, IDFAIL, IDSVCOUT, ACCREG, ACCREGFAIL, ACCCLOSED, ACCLOCKED, ACCLOGINFAIL, SCOREREF, REPORTREF, TEST, ERROR"
}
]
},
"description": "Send a sample webhook request for a registered userid under your host.\n\nChoose a webhook type from: ACCNEW, IDFAIL, IDSVCOUT, ACCREG, ACCREGFAIL, ACCCLOSED, ACCLOCKED, ACCLOGINFAIL, SCOREREF, REPORTREF, TEST, ERROR"
},
"response": []
},
{
"name": "Webhook Sink",
"event": [
{
"listen": "test",
"script": {
"exec": [
"//var data = pm.response;",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "test",
"type": "string"
},
{
"key": "username",
"value": "test",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[{\r\n \"type\": \"ERROR\",\r\n \"user_id\": \"d9126b53-48ea-40b7-933d-3bc6084f287e\",\r\n \"time\": \"2020-07-26T05:36:00\",\r\n \"error_code\": \"SC999\",\r\n \"error_msg\": \"Test Error\"\r\n}]",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/test/webhook/sink",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"test",
"webhook",
"sink"
],
"query": [
{
"key": "fail",
"value": "true",
"disabled": true
}
]
},
"description": "This endpoint simulates sending a webhook. The current URL responds with success unless the fail parameter is marked.\n\nUse to directly verify that your webhook endpoint is working. Change the URL to point to your server endpoint. Update the Basic Authentication username & password accordingly."
},
"response": []
},
{
"name": "Webhook Test: Alert",
"event": [
{
"listen": "test",
"script": {
"exec": [
"//var data = pm.response.json();",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "test",
"type": "string"
},
{
"key": "username",
"value": "test",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"alertId\":\"CRT:36641804\",\"alertType\":\"BlockedInquiryAlert\",\"creationDate\":\"2021-01-02-20:32\",\"dataSource\":\"EQUIFAX\",\"dateReported\":\"2021-01-02-20:31\",\"enrollmentId\":\"281380\",\"partnerKey\":\"3e78eae7-a3d0-4b72-9bc3-6493b91e84b6\",\"reportingFrequency\":\"RTINQ\",\"tenantKey\":\"EFX-US\",\"institutionType\":\"Miscellaneous Utilities\",\"institutionName\":\"APPLIED TECHNOLOGY GROUP INC\",\"memberNumber\":\"990UZ07496\",\"inquiryIntent\":\"Real Estate\",\"postedDuringMaintenancePeriod\":\"no\",\"inquiryType\":\"CR\",\"endUserText\":\"Naval Credit Union\",\"institutionAddressLine1\":\"Site Address 1\",\"institutionAddressLine2\":\"St# 2 2nd line\",\"institutionCity\":\"ROANOKE\",\"institutionState\":\"IN\",\"institutionPostalCode\":\"46783\",\"institutionPhoneNumber\":\"\",\"customerReferenceNumber\":\"6B0A07E6-4965-4063-A866-5A96C3E21762\"}"
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/test/webhook/send/{{userId}}?count=1&type=ACCALERT",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"test",
"webhook",
"send",
"{{userId}}"
],
"query": [
{
"key": "count",
"value": "1"
},
{
"key": "type",
"value": "ACCALERT"
}
]
},
"description": "Send a sample alert request for a registered userid under your host. The sample alert body included is representative of a real-time alert. Standard alerts have considerably less information. The additional alert information is only available using the Direct API endpoint Get Alert Detail at this time."
},
"response": []
}
]
}
Direct & User APIs: Consumer Credit - Getting Started - New User.postman_collection.json
{
"info": {
"_postman_id": "f65c1f1d-3127-4b15-9ee6-0b85182b16e5",
"name": "CRS - Getting Started - New User",
"description": "Consumer API - Getting Started Instructions \r\nUse the provided Postman Environment in conjunction with this collection of requests. \r\nThe steps are provided in order to create a new user and retrieve the data. \r\n\r\nThe Consumer Credit - Getting Started - New User.postman_collection.json will walk you through the Create New User steps in order",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Step 1: Customer Login",
"event": [
{
"listen": "test",
"script": {
"id": "c973714d-5902-4cb8-a5f7-a0668ecbfba9",
"exec": [
"var data = pm.response.json();",
"if(data) {",
" if(data.token) pm.environment.set(\"dtoken\",data.token);",
" if(data.refresh) pm.environment.set(\"rdtoken\",data.refresh);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"secret\": \"{{SECRET}}\",\n \"apikey\": \"{{API_KEY}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/login",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"login"
]
},
"description": "Using your credentials in the request body (\"apikey\" and \"secret\"), the response will contain the token and refresh token. \r\nThese tokens are required for completing the other requests to Direct API endpoints.\r\n\r\nThis token will be valid for approximately one hour. After the one hour, the refresh token will become valid.\r\n\r\nIf the token expires, use /direct/refresh-token?token={refresh} to get a new token"
},
"response": []
},
{
"name": "Step 2: Register New User",
"event": [
{
"listen": "test",
"script": {
"id": "e792209a-7d96-47bf-9d1e-34f0a81b407b",
"exec": [
"var data = pm.response.json();",
"if (data) {",
" if (data.token) pm.environment.set(\"paToken\", data.token);",
" if (data.userId) pm.environment.set(\"userId\", data.userId);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"email\":\"{{USER_EMAIL}}\",\"fname\":\"{{USER_FNAME}}\",\"lname\":\"{{USER_LNAME}}\",\"mobile\":\"{{USER_MOBILE}}\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/user-reg",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"user-reg"
]
},
"description": "Creates a new user with unique userId and preauth token.\r\n\r\nWhen a user logs back in, use /direct/preauth-token/{userId} to generate that user a new preauth token and a new userId (refer to Returning User)\r\n\r\nDon't store the token across sessions. Use the userId from the previous session to generate a new userId and a new preauth token."
},
"response": []
},
{
"name": "Step 3: Preauth Token",
"event": [
{
"listen": "test",
"script": {
"id": "4ec1bd9d-1e69-4bee-ab8f-e62bfb4936a2",
"exec": [
"var data = pm.response.json();\r",
"if (data) {\r",
" if (data.token) pm.environment.set(\"utoken\", data.token);\r",
" if (data.refresh) pm.environment.set(\"rutoken\", data.refresh);\r",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/preauth-token/{{paToken}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"preauth-token",
"{{paToken}}"
]
},
"description": "This request uses userId (from the response of /direct/user-reg) to generate a User Token.\r\n\r\nThe Preauth Token needed for this request is also generated by /direct/user-reg or /direct/preauth-token"
},
"response": []
},
{
"name": "Step 4: User Identity",
"event": [
{
"listen": "test",
"script": {
"id": "4844f292-674b-4a57-aeb9-fcc54b7f32c3",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"ssn\":\"{{USER_SSN}}\",\"dob\":\"{{USER_DOB}}\",\"mobile\":\"{{USER_MOBILE}}\",\"street1\":\"{{USER_STREET1}}\",\"street2\":\"{{USER_STREET2}}{{$randomint}}\",\"city\":\"{{USER_CITY}}\",\"state\":\"{{USER_STATE}}\",\"zip\":\"{{USER_ZIP}}\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/identity",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"identity"
]
},
"description": "This endpoint is most useful for checking whether the user's identity needs to be verified.\r\n\r\nIf the response has idpass set to true, then the user's identity is already verified.\r\n\r\nIf idpass is false, then the user's identity needs to be verified.\r\n\r\nThe user's identity can be verified with either:\r\n\r\n/users/get-mobile (phone sms verification) \r\n/users/get-quiz (an identity quiz) \r\nThe user's identity must be verified in order to enable the user's device to request the Equifax config data.\r\n\r\nThe data in the Equifax config provides the necessary credentials for making requests to the Equifax API from the consumer's device."
},
"response": []
},
{
"name": "Step 5: Phone Verify",
"event": [
{
"listen": "test",
"script": {
"id": "7b24aa4f-6416-4267-b007-ec17926c66b0",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"mtoken\",data.token);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/get-mobile",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"get-mobile"
]
},
"description": "Using the Phone Verify, Send Mobile Code, Verify Mobile Code method, the code in the test system passes through, so you can just keep clicking the send on those functions, though you will receive the text as well."
},
"response": []
},
{
"name": "Step 6: Send Mobile Code",
"event": [
{
"listen": "test",
"script": {
"id": "e167cb9e-3ed4-4caa-ad53-ec6aa6fdc965",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"mTransactionKey\",data.key);",
"pm.environment.set(\"passcode\",data.passcode);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/send-code/{{mtoken}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"send-code",
"{{mtoken}}"
]
},
"description": "Using the Phone Verify, Send Mobile Code, Verify Mobile Code method, the code in the test system passes through, so you can just keep clicking the send on those functions, though you will receive the text as well."
},
"response": []
},
{
"name": "Step 7: Verify Mobile Code",
"event": [
{
"listen": "test",
"script": {
"id": "f7628e0d-6e0a-4d3e-8047-aa5c7be00c78",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"key\":\"{{mTransactionKey}}\",\"code\":\"{{passcode}}\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/verify-code",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"verify-code"
]
},
"description": "Using the Phone Verify, Send Mobile Code, Verify Mobile Code method, the code in the test system passes through, so you can just keep clicking the send on those functions, though you will receive the text as well."
},
"response": []
},
{
"name": "Step 8: Get EFX Config",
"event": [
{
"listen": "test",
"script": {
"id": "91b6c3dd-27b6-4247-951d-64bdbcd84a3f",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"efx_url\",data.url);",
"pm.environment.set(\"efx_api_key\",data.id);",
"pm.environment.set(\"efx_assertion\",data.secret);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/efx-config",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"efx-config"
]
},
"description": "Use this endpoint to get the Equifax credentials and url\r\n\r\nThese will be needed for the consumer app to send requests to the Equifax API."
},
"response": []
},
{
"name": "Step 9: OAUTH Token",
"event": [
{
"listen": "test",
"script": {
"id": "765b8623-45f4-41ab-9d6a-77cd709b4612",
"exec": [
"var response = JSON.parse(responseBody);",
"postman.setEnvironmentVariable(\"efxtoken\", response.access_token);",
"tests[\"Status code is 200\"] = responseCode.code === 200;"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "scope",
"value": "delivery",
"type": "text"
},
{
"key": "grant_type",
"value": "jwt-bearer",
"type": "text"
},
{
"key": "api_key",
"value": "{{efx_api_key}}",
"type": "text"
},
{
"key": "client_assertion",
"value": "{{efx_assertion}}",
"type": "text"
}
]
},
"url": {
"raw": "{{efx_url}}/oauth/token",
"host": [
"{{efx_url}}"
],
"path": [
"oauth",
"token"
]
},
"description": "For this path parameter, {efx_url}, use the url found in the response of a call to /users/efx-config.\r\n\r\nA successful request to {efx_url}/oauth/token will return credentials required for other Equifax API calls."
},
"response": []
},
{
"name": "[Step 10]: Credit Monitoring",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditMonitoring?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditMonitoring"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 10]: Credit Score Latest",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditScore/latest?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditScore",
"latest"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 10]: Credit Score History",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditScore/history?historicalLimit=24&format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditScore",
"history"
],
"query": [
{
"key": "historicalLimit",
"value": "24"
},
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Step 11: Credit Report List",
"event": [
{
"listen": "test",
"script": {
"id": "c1e02ed8-b430-4b11-9129-b3c55c5177e2",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"reportId\",data[0].id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 12]: Credit Report Summary (First in list)",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}/summary?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}",
"summary"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 12]: Full Credit Report (First in list)",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 12]: Credit Report (First in list) - PRINT",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}/print?access_token={{efxtoken}}",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}",
"print"
],
"query": [
{
"key": "access_token",
"value": "{{efxtoken}}"
}
]
}
},
"response": []
}
],
"protocolProfileBehavior": {}
}
Direct & User APIs: Consumer Credit - Getting Started - Returning User.postman_collection.json
{
"info": {
"_postman_id": "f65c1f1d-3127-4b15-9ee6-0b85182b16e5",
"name": "CRS - Getting Started - Returning User",
"description": "Consumer API - Getting Started Instructions \r\nUse the provided Postman Environment in conjunction with this collection of requests. \r\nThe steps are provided in order to handle a returning user and retrieve the data. \r\n\r\nThe Consumer Credit - Getting Started - Returning User.postman_collection.json will walk you through the Returning User steps in order",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Step 1: Customer Login",
"event": [
{
"listen": "test",
"script": {
"id": "c973714d-5902-4cb8-a5f7-a0668ecbfba9",
"exec": [
"var data = pm.response.json();",
"if(data) {",
" if(data.token) pm.environment.set(\"dtoken\",data.token);",
" if(data.refresh) pm.environment.set(\"rdtoken\",data.refresh);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"secret\": \"{{SECRET}}\",\n \"apikey\": \"{{API_KEY}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/login",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"login"
]
},
"description": "Using your credentials in the request body (\"apikey\" and \"secret\"), the response will contain the token and refresh token. \r\nThese tokens are required for completing the other requests to Direct API endpoints.\r\n\r\nThis token will be valid for approximately one hour. After the one hour, the refresh token will become valid.\r\n\r\nIf the token expires, use /direct/refresh-token?token={refresh} to get a new token"
},
"response": []
},
{
"name": "Step 2: New User Token",
"event": [
{
"listen": "test",
"script": {
"id": "75867ce0-7f8d-4531-a7f1-9939d485fb60",
"exec": [
"var data = pm.response.json();",
"if (data) {",
" if (data.token) pm.environment.set(\"paToken\", data.token);",
" if (data.userId) pm.environment.set(\"userId\", data.userId);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/preauth-token/{{userId}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"preauth-token",
"{{userId}}"
]
},
"description": "This request uses userId (from the response of /direct/user-reg) to generate a User Token.\r\n\r\nThe Preauth Token needed for this request is also generated by /direct/user-reg or /direct/preauth-token"
},
"response": []
},
{
"name": "Step 3: Preauth Token",
"event": [
{
"listen": "test",
"script": {
"id": "4ec1bd9d-1e69-4bee-ab8f-e62bfb4936a2",
"exec": [
"var data = pm.response.json();\r",
"if (data) {\r",
" if (data.token) pm.environment.set(\"utoken\", data.token);\r",
" if (data.refresh) pm.environment.set(\"rutoken\", data.refresh);\r",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/preauth-token/{{paToken}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"preauth-token",
"{{paToken}}"
]
},
"description": "This request uses **userId** (from the response of **/direct/user-reg**) to generate a **User Token**.\r\n\r\n*The Preauth Token needed for this request is also generated by* ***/direct/user-reg*** *or* ***/direct/preauth-token***"
},
"response": []
},
{
"name": "Step 4: Get EFX Config",
"event": [
{
"listen": "test",
"script": {
"id": "91b6c3dd-27b6-4247-951d-64bdbcd84a3f",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"efx_url\",data.url);",
"pm.environment.set(\"efx_api_key\",data.id);",
"pm.environment.set(\"efx_assertion\",data.secret);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/efx-config",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"efx-config"
]
},
"description": "Use this endpoint to get the Equifax credentials and url\r\n\r\nThese will be needed for the consumer app to send requests to the Equifax API."
},
"response": []
},
{
"name": "Step 5: OAUTH Token",
"event": [
{
"listen": "test",
"script": {
"id": "765b8623-45f4-41ab-9d6a-77cd709b4612",
"exec": [
"var response = JSON.parse(responseBody);",
"postman.setEnvironmentVariable(\"efxtoken\", response.access_token);",
"tests[\"Status code is 200\"] = responseCode.code === 200;"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "scope",
"value": "delivery",
"type": "text"
},
{
"key": "grant_type",
"value": "jwt-bearer",
"type": "text"
},
{
"key": "api_key",
"value": "{{efx_api_key}}",
"type": "text"
},
{
"key": "client_assertion",
"value": "{{efx_assertion}}",
"type": "text"
}
]
},
"url": {
"raw": "{{efx_url}}/oauth/token",
"host": [
"{{efx_url}}"
],
"path": [
"oauth",
"token"
]
},
"description": "For this path parameter, {efx_url}, use the url found in the response of a call to /users/efx-config.\r\n\r\nA successful request to {efx_url}/oauth/token will return credentials required for other Equifax API calls."
},
"response": []
},
{
"name": "[Step 6]: Credit Monitoring",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditMonitoring?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditMonitoring"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 6]: Credit Score Latest",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditScore/latest?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditScore",
"latest"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 6]: Credit Score History",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditScore/history?historicalLimit=24&format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditScore",
"history"
],
"query": [
{
"key": "historicalLimit",
"value": "24"
},
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Step 7: Credit Report List",
"event": [
{
"listen": "test",
"script": {
"id": "c1e02ed8-b430-4b11-9129-b3c55c5177e2",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"reportId\",data[0].id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 8]: Credit Report Summary (First in list)",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}/summary?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}",
"summary"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 8]: Full Credit Report (First in list)",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "[Step 8]: Credit Report (First in list) - PRINT",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}/print?access_token={{efxtoken}}",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}",
"print"
],
"query": [
{
"key": "access_token",
"value": "{{efxtoken}}"
}
]
}
},
"response": []
}
],
"protocolProfileBehavior": {}
}
User APIs: Consumer Credit - User API.postman_collection.json
{
"info": {
"_postman_id": "78ea84a5-dd24-48c3-872a-2654e894b062",
"name": "CRS - User API",
"description": "User API calls must originate from the end-client.\r\n\r\nEquifax end-points are accessible by first using the User API /users/efx-config response data, and then the Equifax /oauth/token call.\r\n\r\nUser API and Equifax API calls are intended to be called from the end-client/user's device.\r\n\r\nThe Consumer Credit - User API.postman_collection.json provides all User-oriented APIs",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Preauth Token",
"event": [
{
"listen": "test",
"script": {
"id": "370399eb-c2d3-4d02-b5e6-28e4cd217059",
"exec": [
"var data = pm.response.json();\r",
"if (data) {\r",
" if (data.token) pm.environment.set(\"utoken\", data.token);\r",
" if (data.refresh) pm.environment.set(\"rutoken\", data.refresh);\r",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/preauth-token/{{paToken}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"preauth-token",
"{{paToken}}"
]
},
"description": "This request uses userId (from the response of /direct/user-reg) to generate a User Token.\r\n\r\nThe Preauth Token needed for this request is also generated by /direct/user-reg or /direct/preauth-token"
},
"response": []
},
{
"name": "User Refresh Token",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
"var data = pm.response.json();",
"if(data) {",
" if(data.token) pm.environment.set(\"utoken\",data.token);",
" if(data.refresh) pm.environment.set(\"rutoken\",data.refresh);",
"}"
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
},
{
"key": "",
"type": "text",
"value": "",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/refresh-token?token={{rutoken}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"refresh-token"
],
"query": [
{
"key": "token",
"value": "{{rutoken}}"
}
]
}
},
"response": []
},
{
"name": "User Identity",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"ssn\":\"{{USER_SSN}}\",\"dob\":\"{{USER_DOB}}\",\"mobile\":\"{{USER_MOBILE}}\",\"street1\":\"{{USER_STREET1}}\",\"street2\":\"{{USER_STREET2}}\",\"city\":\"{{USER_CITY}}\",\"state\":\"{{USER_STATE}}\",\"zip\":\"{{USER_ZIP}}\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/identity",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"identity"
]
},
"description": "This endpoint is most useful for checking whether the user's identity needs to be verified.\r\n\r\nIf the response has idpass set to true, then the user's identity is already verified.\r\n\r\nIf idpass is false, then the user's identity needs to be verified.\r\n\r\nThe user's identity can be verified with either:\r\n\r\n/users/get-mobile (phone sms verification) \r\n/users/get-quiz (an identity quiz) \r\nThe user's identity must be verified in order to enable the user's device to request the Equifax config data.\r\n\r\nThe data in the Equifax config provides the necessary credentials for making requests to the Equifax API from the consumer's device."
},
"response": []
},
{
"name": "Phone Verify",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"mtoken\",data.token);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/get-mobile",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"get-mobile"
]
},
"description": "Using the Phone Verify, Send Mobile Code, Verify Mobile Code method, the code in the test system passes through, so you can just keep clicking the send on those functions, though you will receive the text as well."
},
"response": []
},
{
"name": "Send Mobile Code",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"mTransactionKey\",data.key);",
"pm.environment.set(\"passcode\",data.passcode);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/send-code/{{mtoken}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"send-code",
"{{mtoken}}"
]
},
"description": "Using the Phone Verify, Send Mobile Code, Verify Mobile Code method, the code in the test system passes through, so you can just keep clicking the send on those functions, though you will receive the text as well."
},
"response": []
},
{
"name": "Renew Mobile Code",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"mTransactionKey\",data.key);",
"pm.environment.set(\"passcode\",data.passcode);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"key\":\"{{mTransactionKey}}\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/renew-code",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"renew-code"
]
}
},
"response": []
},
{
"name": "Verify Mobile Code",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"key\":\"{{mTransactionKey}}\",\"code\":\"{{passcode}}\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/verify-code",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"verify-code"
]
},
"description": "Using the Phone Verify, Send Mobile Code, Verify Mobile Code method, the code in the test system passes through, so you can just keep clicking the send on those functions, though you will receive the text as well."
},
"response": []
},
{
"name": "Get Identity Quiz",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"qTransactionKey\",data.key);",
"pm.environment.set(\"qzId\",data.id);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/get-quiz",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"get-quiz"
]
}
},
"response": []
},
{
"name": "Verify Identity Quiz",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"key\":\"{{qTransactionKey}}\",\"id\":\"{{qzId}}\",\"answers\": [{\"qid\":1,\"aid\":3},{\"qid\":2,\"aid\":3},{\"qid\":3,\"aid\":3}]}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/verify-quiz",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"verify-quiz"
]
}
},
"response": []
},
{
"name": "Get EFX Config",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"efx_url\",data.url);",
"pm.environment.set(\"efx_api_key\",data.id);",
"pm.environment.set(\"efx_assertion\",data.secret);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{utoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/users/efx-config",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"users",
"efx-config"
]
},
"description": "Use this endpoint to get the Equifax credentials and url\r\n\r\nThese will be needed for the consumer app to send requests to the Equifax API."
},
"response": []
}
],
"protocolProfileBehavior": {}
}
Direct APIs: Consumer Credit - Direct API.postman_collection.json
{
"info": {
"_postman_id": "1e3be246-0e2d-472e-8d8b-462f00852568",
"name": "CRS - Direct API",
"description": "Direct API calls must originate from your server\r\n\r\nA token from /direct/login is required for all other Direct API end-points. It is a bearer authorization token.\r\n\r\nOnce you have a preauth token, returned from /direct/user-reg or /direct/preauth-token, pass it to the Web UI entry point in the embedded iFrame.\r\n\r\nBe sure to save the ID returned from /direct/user-reg or you won’t be able to reauthorize the user when they return.\r\n\r\n**The preauth token is only valid for 30 seconds\r\n\r\nThe Consumer Credit - Direct API.postman_collection.json will walk you through using the Direct API collection",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Customer Login",
"event": [
{
"listen": "test",
"script": {
"id": "c7ffe89c-fa8a-4891-9231-e69679dc2259",
"exec": [
"var data = pm.response.json();",
"if(data) {",
" if(data.token) pm.environment.set(\"dtoken\",data.token);",
" if(data.refresh) pm.environment.set(\"rdtoken\",data.refresh);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"secret\": \"{{SECRET}}\",\n \"apikey\": \"{{API_KEY}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/login",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"login"
]
},
"description": "Using your credentials in the request body (\"apikey\" and \"secret\"), the response will contain the token and refresh token. \r\nThese tokens are required for completing the other requests to Direct API endpoints.\r\n\r\nThis token will be valid for approximately one hour. After the one hour, the refresh token will become valid.\r\n\r\nIf the token expires, use /direct/refresh-token?token={refresh} to get a new token"
},
"response": []
},
{
"name": "Customer Refresh Token",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
"var data = pm.response.json();",
"if(data) {",
" if(data.token) pm.environment.set(\"dtoken\",data.token);",
" if(data.refresh) pm.environment.set(\"rdtoken\",data.refresh);",
"}"
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
},
{
"key": "",
"type": "text",
"value": "",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/refresh-token?token={{rdtoken}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"refresh-token"
],
"query": [
{
"key": "token",
"value": "{{rdtoken}}"
}
]
},
"description": "Token and refresh tokes are required for completing the other requests to Direct API endpoints.\r\n\r\nThe token will be valid for approximately one hour. After the one hour, the refresh token will become valid.\r\n\r\nWhen the token expires, use /direct/refresh-token?token={refresh} to get a new token"
},
"response": []
},
{
"name": "Register New User",
"event": [
{
"listen": "test",
"script": {
"id": "550c9d9e-0719-4eea-9ee8-dbc634154585",
"exec": [
"var data = pm.response.json();",
"if (data) {",
" if (data.token) pm.environment.set(\"paToken\", data.token);",
" if (data.userId) pm.environment.set(\"userId\", data.userId);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"email\":\"{{USER_EMAIL}}\",\"fname\":\"{{USER_FNAME}}\",\"lname\":\"{{USER_LNAME}}\",\"mobile\":\"{{USER_MOBILE}}\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/user-reg",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"user-reg"
]
},
"description": "Creates a new user with unique userId and preauth token.\r\n\r\nWhen a user logs back in, use /direct/preauth-token/{userId} to generate that user a new preauth token and a new userId (refer to Returning User)\r\n\r\nDon't store the token across sessions. Use the userId from the previous session to generate a new userId and a new preauth token."
},
"response": []
},
{
"name": "New User Token",
"event": [
{
"listen": "test",
"script": {
"id": "ceca0cf9-2f98-4dce-9c20-ec51795e6aa1",
"exec": [
"var data = pm.response.json();",
"if (data) {",
" if (data.token) pm.environment.set(\"paToken\", data.token);",
" if (data.userId) pm.environment.set(\"userId\", data.userId);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/preauth-token/{{userId}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"preauth-token",
"{{userId}}"
]
}
},
"response": []
},
{
"name": "Close User Account",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/close-account/{{userId}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"close-account",
"{{userId}}"
]
}
},
"response": []
},
{
"name": "Change User Email",
"event": [
{
"listen": "test",
"script": {
"id": "c3d8c071-4aa5-4622-ac58-0a2597c34f87",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"email\": \"test@test.com\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/change-email/{{userId}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"change-email",
"{{userId}}"
]
}
},
"response": []
},
{
"name": "Change User Phone",
"event": [
{
"listen": "test",
"script": {
"id": "870bd1c5-5348-49ad-9fc1-7e05469b2ef9",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"mobile\": \"1234567890\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/change-mobile/{{userId}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"change-mobile",
"{{userId}}"
]
}
},
"response": []
},
{
"name": "Change User Host",
"event": [
{
"listen": "test",
"script": {
"id": "e93f5174-f782-4c38-8a95-5dfb4e336521",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/change-host/{{userId}}?host={{HOST_ID}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"change-host",
"{{userId}}"
],
"query": [
{
"key": "host",
"value": "{{HOST_ID}}"
}
]
}
},
"response": []
},
{
"name": "Update User Refresh Date",
"event": [
{
"listen": "test",
"script": {
"id": "04ee5e00-2b02-429f-b7bb-dcfcc9451d13",
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/update-refresh/{{userId}}?rmonly=false",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"update-refresh",
"{{userId}}"
],
"query": [
{
"key": "rmonly",
"value": "false"
}
]
},
"description": "*Premium Feature - May Require Additional Access"
},
"response": []
},
{
"name": "Get Alert Detail",
"event": [
{
"listen": "test",
"script": {
"id": "50689d78-4a1f-4f41-9eb3-698257f83698",
"exec": [
"var data = pm.response.json();",
"if (data) {",
" if (data.token) pm.environment.set(\"paToken\", data.token);",
" if (data.userId) pm.environment.set(\"userId\", data.userId);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{dtoken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "{{PROTOCOL}}://{{HOST}}:{{PORT}}{{BASE_URL}}/direct/efx-alert/{{alertId}}",
"protocol": "{{PROTOCOL}}",
"host": [
"{{HOST}}"
],
"port": "{{PORT}}{{BASE_URL}}",
"path": [
"direct",
"efx-alert",
"{{alertId}}"
]
},
"description": "*Premium Feature - May Require Additional Access"
},
"response": []
}
],
"protocolProfileBehavior": {}
}
Equifax APIs: Consumer Credit - EFX API.postman_collection.json
{
"info": {
"_postman_id": "6a775eeb-7324-447c-9564-157940e7d587",
"name": "CRS - EFX API",
"description": "Equifax API calls must originate from the end-client\r\n\r\nEquifax end-points are accessible by first using the User API /users/efx-config response data, and then the Equifax /oauth/token call. As mentioned above, User API and Equifax API calls are intended to be called from the end-client/user's device.\r\n\r\nThe Consumer Credit - EFX API.postman_collection.json has examples for all Equifax APIs",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "OAUTH Token",
"event": [
{
"listen": "test",
"script": {
"id": "cad6b17b-9322-4759-9809-c06b85ddeca9",
"exec": [
"var response = JSON.parse(responseBody);",
"postman.setEnvironmentVariable(\"efxtoken\", response.access_token);",
"tests[\"Status code is 200\"] = responseCode.code === 200;"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "scope",
"value": "delivery",
"type": "text"
},
{
"key": "grant_type",
"value": "jwt-bearer",
"type": "text"
},
{
"key": "api_key",
"value": "{{efx_api_key}}",
"type": "text"
},
{
"key": "client_assertion",
"value": "{{efx_assertion}}",
"type": "text"
}
]
},
"url": {
"raw": "{{efx_url}}/oauth/token",
"host": [
"{{efx_url}}"
],
"path": [
"oauth",
"token"
]
},
"description": "For this path parameter, {efx_url}, use the url found in the response of a call to /users/efx-config.\r\n\r\nA successful request to {efx_url}/oauth/token will return credentials required for other Equifax API calls."
},
"response": [
{
"name": "response",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "scope",
"value": "delivery",
"type": "text"
},
{
"key": "grant_type",
"value": "jwt-bearer",
"type": "text"
},
{
"key": "api_key",
"value": "{{efx_api_key}}",
"type": "text"
},
{
"key": "client_assertion",
"value": "{{efx_assertion}}",
"type": "text"
}
]
},
"url": {
"raw": "{{efx_url}}/oauth/token",
"host": [
"{{efx_url}}"
],
"path": [
"oauth",
"token"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "javascript",
"header": [
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate, no-store",
"name": "Cache-Control",
"description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"
},
{
"key": "Content-Encoding",
"value": "gzip",
"name": "Content-Encoding",
"description": "The type of encoding used on the data."
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8",
"name": "Content-Type",
"description": "The mime type of this content"
},
{
"key": "Date",
"value": "Thu, 06 Aug 2015 13:31:36 GMT",
"name": "Date",
"description": "The date and time that the message was sent"
},
{
"key": "Expires",
"value": "0",
"name": "Expires",
"description": "Gives the date/time after which the response is considered stale"
},
{
"key": "Pragma",
"value": "no-cache, no-cache",
"name": "Pragma",
"description": "Implementation-specific headers that may have various effects anywhere along the request-response chain."
},
{
"key": "Server",
"value": "Apache-Coyote/1.1",
"name": "Server",
"description": "A name for the server"
},
{
"key": "Transfer-Encoding",
"value": "chunked",
"name": "Transfer-Encoding",
"description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."
},
{
"key": "Vary",
"value": "Accept-Encoding",
"name": "Vary",
"description": "Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."
},
{
"key": "X-Content-Type-Options",
"value": "nosniff",
"name": "X-Content-Type-Options",
"description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"
},
{
"key": "X-Frame-Options",
"value": "DENY",
"name": "X-Frame-Options",
"description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block",
"name": "X-XSS-Protection",
"description": "Cross-site scripting (XSS) filter"
}
],
"cookie": [],
"body": "{\"access_token\":\"87e22d35-0089-4613-809b-62f248c2c978\",\"token_type\":\"bearer\",\"expires_in\":610,\"scope\":\"read write\"}"
}
]
},
{
"name": "Health Check",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "{{content-type}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditMonitoring/healthcheck?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditMonitoring",
"healthcheck"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Credit Monitoring",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditMonitoring?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditMonitoring"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Credit Report List",
"event": [
{
"listen": "test",
"script": {
"id": "64ef860f-2992-4d8b-a1f4-86173f8e1793",
"exec": [
"var data = pm.response.json();",
"pm.environment.set(\"reportId\",data[0].id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Credit Report Summary (First in list)",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}/summary?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}",
"summary"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Full Credit Report (First in list)",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Credit Report (First in list) - PRINT",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{efx_url}}/v1/creditReport/{{reportId}}/print?access_token={{efxtoken}}",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditReport",
"{{reportId}}",
"print"
],
"query": [
{
"key": "access_token",
"value": "{{efxtoken}}"
}
]
}
},
"response": []
},
{
"name": "Credit Score Latest",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditScore/latest?format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditScore",
"latest"
],
"query": [
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
},
{
"name": "Credit Score History",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{efxtoken}}"
}
],
"url": {
"raw": "{{efx_url}}/v1/creditScore/history?historicalLimit=24&format=json",
"host": [
"{{efx_url}}"
],
"path": [
"v1",
"creditScore",
"history"
],
"query": [
{
"key": "historicalLimit",
"value": "24"
},
{
"key": "format",
"value": "json"
}
]
}
},
"response": []
}
],
"protocolProfileBehavior": {}
}