{"openapi":"3.0.0","info":{"title":"Refined Fuels USMD API","version":"1.3.0","description":"Summarized product volumes by U.S., PADD, Rack City & Terminal"},"servers":[{"url":"https://traderinsights-cat.dtn.com/repo_usmd_api","description":"Production"},{"url":"https://traderinsights-cat.dtn.com/repo_usmd_api","description":"Customer Acceptance Test"}],"paths":{"/padd-daily":{"get":{"tags":["PADD Daily"],"summary":"Daily summaries of transactional refined products volumes for rack loadings at the PADD.","operationId":"GetDailyPADDs","parameters":[{"name":"apiKey","in":"header","description":"Key that provides access to this API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"regions","in":"query","description":"List of PADD regions separated by commas.\nValue of 1 groups 1A, 1B, 1C. 1 excludes 1A,1B,1C\nValue of USA groups all regions. USA excludes all other regions\n","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["1A","1B","1C","1","2","3","4","5","USA"]}},{"name":"products","in":"query","description":"List of general refined products classes (gasoline or distillates) separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["Distillates","Gas"]}},{"name":"grades","in":"query","description":"List of grades separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["Aviation","Bio","Jet","Kero","Midgrade","#1 Diesel","#2 Diesel","Premium","Regular","Residual"]}},{"name":"limit","in":"query","description":"Deprecated. Specifies number (1-5000) of records that will be provided. Default 200.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Deprecated. Specifies number of records that will be skipped. When not provided, the returned records will start with the first record.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"This is the page being requested. The default is page 1.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"This is the amount of objects on each page. Default is 200.  Maximum is 5000.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"startDate","in":"query","description":"Beginning of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Format of the response data. If not provided, the type specified by the Accept header will be used. If neither are provided, the type returned will be JSON.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of Daily PADDs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyPADDs"},"example":[{"period":"2019-01-01","region":"1","product":"Distillates","grade":"No. 2 Diesel Fuel","sumNetVolume":2031,"bioVolume":500,"coverageFactor":1.114887865,"effectiveDateTime":"2019-01-03T00:00:00Z"}]}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/rack-daily":{"get":{"tags":["Rack Daily"],"summary":"Daily summaries of transactional refined products volumes and spot price at the rack city level.","operationId":"GetRacksDaily","parameters":[{"name":"apiKey","in":"header","description":"Key that provides access to this API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"regions","in":"query","description":"List of PADD regions separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["1","2","3","4","5"]}},{"name":"products","in":"query","description":"List of general refined products classes (gasoline or distillates) separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["Distillates","Gas"]}},{"name":"grades","in":"query","description":"List of grades separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["Aviation","Bio","Jet","Kero","Midgrade","#1 Diesel","#2 Diesel","Premium","Regular","Residual"]}},{"name":"rackAverage","in":"query","description":"Narrow results by filtering on Y or N for rackAverage","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["Y","N"]}},{"name":"states","in":"query","description":"List of state abbreviations separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Deprecated. Specifies number (1-5000) of records that will be provided. Default 200.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Deprecated. Specifies number of records that will be skipped. When not provided, the returned records will start with the first record.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"This is the page being requested. The default is page 1.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"This is the amount of objects on each page. Default is 200.  Maximum is 5000.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"startDate","in":"query","description":"Beginning of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Format of the response data. If not provided, the type specified by the Accept header will be used. If neither are provided, the type returned will be JSON.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of Daily Racks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyRacks"},"example":[{"period":"2019-01-01","rackId":320,"rackName":"Bridgeport","state":"CT","region":"1","product":"Distillates","grade":"No. 2 Diesel Fuel","sumNetVolume":203,"rackAverage":"N","effectiveDateTime":"2019-01-03T00:00:00Z"}]}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/supplier-terminal-monthly":{"get":{"tags":["Supplier Terminal Monthly Counts"],"summary":"Monthly details of average supplier and terminal counts for refined products rack loadings by product grade rack city at monitored rack.","operationId":"GetSupplierTerminalCountsMontly","parameters":[{"name":"apiKey","in":"header","description":"Key that provides access to this API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"regions","in":"query","description":"List of PADD regions separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["1","2","3","4","5"]}},{"name":"products","in":"query","description":"List of general refined products classes (gasoline or distillates) separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["Distillates","Gas"]}},{"name":"grades","in":"query","description":"List of grades separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["Aviation","Bio","Jet","Kero","Midgrade","#1 Diesel","#2 Diesel","Premium","Regular","Residual"]}},{"name":"rackNames","in":"query","description":"List of rack cities separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"states","in":"query","description":"List of state abbreviations separated by commas","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"supplierMinCount","in":"query","description":"Filter racks by minimum number of suppliers.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"terminalMinCount","in":"query","description":"Filter racks by minimum number of terminals.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Deprecated. Specifies number (1-5000) of records that will be provided. Default 200.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Deprecated. Specifies number of records that will be skipped. When not provided, the returned records will start with the first record.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"This is the page being requested. The default is page 1.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"This is the amount of objects on each page. Default is 200.  Maximum is 5000.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"startDate","in":"query","description":"Beginning of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Format of the response data. If not provided, the type specified by the Accept header will be used. If neither are provided, the type returned will be JSON.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Supplier Terminal Monthly Counts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierTerminalMonthlyCounts"},"example":[{"period":"2018-12-01","rackName":"Anchorage","state":"AK","region":"5","product":"Distillates","grade":"Jet Fuel","supplierMinCount":1,"terminalMinCount":2}]}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/coverage-daily":{"get":{"tags":["Coverage Daily"],"summary":"Daily coverage factors for transactional refined product volumes at PADD or United States level.","operationId":"GetDailyCoverages","parameters":[{"name":"apiKey","in":"header","description":"Key that provides access to this API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"regions","in":"query","description":"List of PADD regions separated by commas.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["1A","1B","1C","1","2","3","4","5","USA"]}},{"name":"limit","in":"query","description":"Deprecated. Specifies number (1-5000) of records that will be provided. Default 200.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Deprecated. Specifies number of records that will be skipped. When not provided, the returned records will start with the first record.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"This is the page being requested. The default is page 1.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"This is the amount of objects on each page. Default is 200.  Maximum is 5000.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"startDate","in":"query","description":"Beginning of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End of date range (e.g. \"YYYY-MM-DD\").","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Format of the response data. If not provided, the type specified by the Accept header will be used. If neither are provided, the type returned will be JSON.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of Daily Coverage Factors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyCoverages"},"example":[{"period":"2019-01-01","region":"1","coverageFactor":1.114887865,"effectiveDateTime":"2019-01-03T00:00:00Z"}]}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"DailyPADDs":{"type":"array","items":{"$ref":"#/components/schemas/DailyPADD"}},"DailyPADD":{"type":"object","properties":{"period":{"type":"string","description":"Date for data collection Data Format: ISO8601 date format using the pattern \"YYYY-MM-DD\"","format":"date"},"region":{"type":"string","description":"Padd where rack city is located"},"product":{"type":"string","description":"General refined products class (gasoline or distillates)"},"grade":{"type":"string","description":"Specific grade"},"sumNetVolume":{"type":"number","description":"Aggregated volume","format":"double"},"bioVolume":{"type":"number","description":"Volume of biofuel blended into finished product","format":"double"},"coverageFactor":{"type":"number","description":"Coverage factor for specified region. \"-1\" returned if not available","format":"double"},"effectiveDateTime":{"type":"string","description":"Timestamp of data retrieval in CST: \"YYYY-MM-DDThh:mm:ssZ\"","format":"date-time"}}},"DailyRacks":{"type":"array","items":{"$ref":"#/components/schemas/DailyRack"}},"DailyRack":{"type":"object","properties":{"period":{"type":"string","description":"Date for data collection Data Format: ISO8601 date format using the pattern \"YYYY-MM-DD\"","format":"date"},"rackId":{"type":"number","description":"ID for rack city"},"rackName":{"type":"string","description":"Name of rack city"},"state":{"type":"string","description":"State where rack city is located"},"region":{"type":"string","description":"Padd where rack city is located"},"product":{"type":"string","description":"General refined products class (gasoline or distillates)"},"grade":{"type":"string","description":"Specific grade"},"sumNetVolume":{"type":"number","description":"Aggregated volume","format":"double"},"rackAverage":{"type":"string","description":"Indicates whether sumNetVolume has been replaced by state average due to low supplier count. (Y/N)"},"effectiveDateTime":{"type":"string","description":"Timestamp of data retrieval in CST: \"YYYY-MM-DDThh:mm:ssZ\"","format":"date-time"}}},"SupplierTerminalMonthlyCounts":{"type":"array","items":{"$ref":"#/components/schemas/SupplierTerminalMonthlyCount"}},"SupplierTerminalMonthlyCount":{"type":"object","properties":{"period":{"type":"string","description":"Date for data collection Data Format: ISO8601 date format using the pattern \"YYYY-MM-DD\"","format":"date"},"rackName":{"type":"string","description":"Name of rack city"},"state":{"type":"string","description":"Two letter abbreviation for state where rack city is located"},"region":{"type":"string","description":"Specific PADD region"},"product":{"type":"string","description":"General refined products class (gasoline or distillates)"},"grade":{"type":"string","description":"Specific grade"},"supplierMinCount":{"type":"integer","description":"Average number of suppliers for a given rack and product","format":"int64"},"terminalMinCount":{"type":"integer","description":"Average number of terminals for a given rack and product","format":"int64"}}},"DailyCoverages":{"type":"array","items":{"$ref":"#/components/schemas/DailyCoverage"}},"DailyCoverage":{"type":"object","properties":{"period":{"type":"string","description":"Date for data collection Data Format: ISO8601 date format using the pattern \"YYYY-MM-DD\"","format":"date"},"region":{"type":"string","description":"Padd where rack city is located. Value \"USA\" for all PADDs"},"coverageFactor":{"type":"number","description":"Coverage factor for specified region","format":"double"},"effectiveDateTime":{"type":"string","description":"Timestamp of data retrieval in CST: \"YYYY-MM-DDThh:mm:ssZ\"","format":"date-time"}}},"Error":{"required":["code","message"],"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}},"securitySchemes":{"clientCredentials":{"type":"oauth2","x-receive-token-in":"request-body","flows":{"clientCredentials":{"tokenUrl":"https://api.auth.dtn.com/v1/tokens/authorize"}},"description":"# Using DAIS for M2M/API Auth\nYou have been given a Client ID and a Client Secret, which are used to request a DTN Access Token. DTN Access Tokens are required when making calls to each and every DTN API endpoint. The following information provides additional details on these tokens and how they are generated.\n## What is an Access Token and how is it different from an API Key?\nAn API Key is a random string of characters that an API uses to authorize whether or not a calling client has approved access to an endpoint. These keys are a non-standard approach to API authorization and are generally issued on a per-API basis.\n\nAn Access Token is also a string of characters but is a base-64 encoded JavaScript Object Notation Web Token, or JWT. JWTs are a widely accepted standard that use OAuth concepts and approaches. \n\nBoth API Keys and Access Tokens are used in an Authorization Request Header as a Bearer, meaning there is no difference in where you put this string of characters when you make calls to DTN APIs.\n## How to generate an Access Token?\nWhen requested, an Access Token is generated for your specific Client (ID/Secret) and for a specific API. The DTN Auth and Identity Service (DAIS) generates new Access Tokens for your client. The DAIS endpoint is `POST https://api.auth.dtn.com/v1/tokens/authorize`.\n\nThis endpoint takes two Header parameters:\n  * `Content-Type: application/json`\n  * `Accept: application/json`\n\nThis endpoint takes four parameters in the Request Body:\n  * `grant_type`: this should always be client_credentials for generating machine-to-machine tokens.\n  * `client_id`: this is the Client ID or Application ID using the token and is given to you by DTN's Identity Team. This ID will never change for your client/application.\n  * `client_secret`: this is the Client Secret that is associated with the Application ID and is given to you by DTN's Identity Team. This key is subject to rotation for security purposes but always with the client's knowledge.\n  * `audience`: this is the API for which this Access Token will be used. For the DTN Refined Fuels Demand, you need to use the following audience: https://traderinsights-cat.dtn.com/repo_usmd_api\n\nYou can use this CURL command template as a reference for obtaining an access token:\n  ```\n  curl --location --request POST 'https://api.auth.dtn.com/v1/tokens/authorize' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"grant_type\": \"client_credentials\",\n\"client_id\": \"insert your client id here\",\n\"client_secret\": \"insert your client secret here\",\n\"audience\": \"insert your audience here\"\n}' \n  ```\n\n*This document, for demonstration purposes, supplies a client_id and client_secret in all code examples. This client/application is for a fictitious API and cannot be used in practice to gain unauthorized access to any other DTN API.*\nUpon generating a new Access Token, you should receive an HTTP Response from DAIS similar to this:\n  ```\n  {\n    \"data\": {\n          \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw\",\n          \"scope\": \"read:demo create:demo update:demo\",\n          \"expires_in\": 90,\n          \"token_type\": \"Bearer\"\n      },\n      \"meta\": {\n          \"date_time\": \"2022-06-24T19:09:42.963Z\",\n          \"name\": \"v1.tokens.authorize\",\n          \"uuid\": \"ee6f9feb-dcf8-4421-a6fd-efd6beabdaa9\",\n          \"start_timestamp\": 1656097782509,\n          \"end_timestamp\": 1656097782963,\n          \"execution_time\": 454\n      }\n  }\n  ```\nLooking at this Response, you will see:\n  * `access_token`: contains the JWT Access Token string you will use as your Bearer token.\n  * `scope`: contains the scopes that this Access Token gives you permissions to access.\n  * `expires_in`: contains the length of time before this Access Token will expire, in seconds.\n  * `token_type`: verifies that this Access Token should be used as a Bearer token.\n\n## How to use an Access Token after one is generated?\nOnce a new Access Token is obtained, it is used in each call to a DTN API endpoint as a Bearer token in an Authorization Request Header. For example:\n  ```\n  Header: 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw'\n  ```\n\n## Deconstructing the Access Token\nA DTN Access Token carries information within its JWT Body that is available on every API call. By deconstructing the JWT token, our Access Tokens will resemble:\n  ```\n  {\n    \"https://auth.dtn.com/customerId\": \"1234567890Demo\",\n    \"https://auth.dtn.com/productCode\": \"DemoApiP\",\n    \"https://auth.dtn.com/requesterIp\": \"18.213.174.27\",\n    \"https://auth.dtn.com/rps\": \"100\",\n    \"https://auth.dtn.com/tier\": \"Basic\",\n    \"https://auth.dtn.com/quota\": \"999999\",\n    \"iss\": \"https://id.auth.dtn.com/\",\n    \"sub\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM@clients\",\n    \"aud\": \"https://demo-api.auth.dtn.com/\",\n    \"iat\": 1656099068,\n    \"exp\": 1656099158,\n    \"azp\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM\",\n    \"scope\": \"read:demo create:demo update:demo\",\n    \"gty\": \"client-credentials\",\n    \"permissions\": [\n      \"read:demo\",\n      \"create:demo\",\n      \"update:demo\"\n    ]\n  }\n  ```\n### Description of Claims\n\n  | Claim                              | Type                                        | Description                                                                                                                                                                                                                |\n  | -----------------------------------| --------------------------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n  | `https://auth.dtn.com/customerId`  | String                                      | Custom DTN claim containing the Customer ID found in the DTN Order Management/Salesforce system associated with this token.                                                                                                |\n  | `https://auth.dtn.com/productCode` | String                                      | Custom DTN claim containing the Identity product code associated with this token.                                                                                                                                          |\n  | `https://auth.dtn.com/requesterIp` | String                                      | Custom DTN claim containing the IP address of the requesting client.                                                                                                                                                       |\n  | `https://auth.dtn.com/rps`         | String                                      | Custom DTN claim containing the maximum rate per second this customer is authorized to utilize.                                                                                                                            |\n  | `https://auth.dtn.com/tier`        | String                                      | Custom DTN claim containing the data tier the customer purchased for the requested access.                                                                                                                                 |\n  | `https://auth.dtn.com/quota`       | String                                      | Custom DTN claim containing the maximum yearly quota the customer purchased for calling DTN endpoints for the specific product.                                                                                            |\n  | `iss`                              | String (URI)                                | The Security Token Service (STS) that issues and returns the token. If this value is not from `https://id.auth.dtn.com/`, the token should not be considered trusted.                                                      |\n  | `sub`                              | String (URI)                                | The principle about which the token asserts information (the User ID or Client ID within the Identity Provider). A User ID will start with a prefix of `auth0\\|`, while the Client ID will end with the suffix `@clients`. |\n  | `aud`                              | String \\| Array (Strings) (URI \\| [URI, …]) | Identifies the intended recipient(s) of the token – its audience. The token should be rejected if the audience does not contain values expected by the calling application.                                                |\n  | `iat`                              | Number (Timestamp)                          | “Issued At” indicates when the authentication for this token occurred.                                                                                                                                                     |\n  | `exp`                              | Number (Timestamp)                          | The “expiration time” on or after which the JWT must not be accepted for processing.                                                                                                                                       |\n  | `azp`                              | String                                      | The application/client ID of the client using the token. The application can cat as itself or on behalf of a user.                                                                                                         |\n  | `gty`                              | String (Space-delimited)                    | The grant type that was used to request the token – not an RFC 7519 registered claim (Auth0-specific).                                                                                                                     |\n  | `permissions`                      | Array (Strings)                             | The grant type that was used to request the token – not an RFC 7519 registered claim (Auth0-specific).                                                                                                                     |\n\n  "}}}}