chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srikar-methodfi merged 1 commit into from
Aug 12, 2026
Merged

chore: add files api + raw crpt artifacts (connect) to openapi spec #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
277 changes: 271 additions & 6 deletions latest/openapi.bundled.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
"name": "Events",
"description": "Webhook event log"
},
{
"name": "Files",
"description": "Downloadable artifacts generated by Method"
},
{
"name": "Forwarding Requests",
"description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
"items": {
"type": "string"
}
},
"bureau": {
"type": "string",
"description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
"enum": [
"equifax",
"transunion"
]
},
"artifacts": {
"type": "array",
"description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
"items": {
"type": "string",
"enum": [
"raw_credit_report",
"credit_report_pdf"
]
}
}
},
"dependentRequired": {
"artifacts": [
"bureau"
]
}
}
}
Expand DownExpand Up@@ -6097,6 +6125,127 @@
}
}
},
"/files/{fileId}": {
"get": {
"operationId": "retrieveFile",
"summary": "Retrieve a file",
"description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
"tags": [
"Files"
],
"security": [
{
"SecretKey": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/method_version"
},
{
"$ref": "#/components/parameters/FileIdParam"
}
],
"responses": {
"200": {
"description": "The requested file.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
}
},
"/files/{fileId}/download": {
"get": {
"operationId": "downloadFile",
"summary": "Download a file",
"description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
"tags": [
"Files"
],
"security": [
{
"SecretKey": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/method_version"
},
{
"$ref": "#/components/parameters/FileIdParam"
}
],
"responses": {
"200": {
"description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
"headers": {
"Content-Disposition": {
"description": "Attachment filename for the downloaded file.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
}
},
"/forwarding_requests": {
"post": {
"operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
"pattern": "^evt_\\w+$"
}
},
"FileIdParam": {
"name": "fileId",
"in": "path",
"required": true,
"description": "Unique identifier for the file.",
"schema": {
"type": "string",
"pattern": "^file_\\w+$"
}
},
"expand_payments": {
"name": "expand",
"in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
}
}
},
"EntityConnectFile": {
"type": "object",
"description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
"required": [
"id",
"type",
"bureau",
"mime_type"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
"pattern": "^file_\\w+$",
"example": "file_jZWkPMhXPeYAn"
},
"type": {
"type": "string",
"description": "The type of artifact this file contains.",
"enum": [
"raw_credit_report",
"credit_report_pdf"
]
},
"bureau": {
"type": "string",
"description": "The credit bureau the file was generated from.",
"enum": [
"transunion",
"equifax"
]
},
"mime_type": {
"type": "string",
"description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
"example": "application/json"
}
}
},
"ConnectResourceError": {
"type": [
"object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
"accounts",
"requested_products",
"requested_subscriptions",
"files",
"created_at",
"updated_at"
],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
}
},
"files": {
"type": [
"array",
"null"
],
"description": "Files associated with this connect session (e.g. manual connect uploads).",
"type": "array",
"description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
"items": {
"$ref": "#/components/schemas/JsonObject"
"$ref": "#/components/schemas/EntityConnectFile"
}
},
"error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
"message": null
}
},
"File": {
"type": "object",
"description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
"required": [
"id",
"type",
"mime_type",
"download_url",
"download_expires_at",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the file.",
"pattern": "^file_\\w+$",
"example": "file_jZWkPMhXPeYAn"
},
"type": {
"type": "string",
"description": "The type of artifact this file contains.",
"enum": [
"raw_credit_report",
"credit_report_pdf"
]
},
"mime_type": {
"type": "string",
"description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
"example": "application/json"
},
"download_url": {
"type": "string",
"format": "uri",
"description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
},
"download_expires_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the file was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the file was last updated."
}
}
},
"FileResponse": {
"allOf": [
{
"$ref": "#/components/schemas/SuccessEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/File"
}
}
}
]
},
"ForwardingRequestCreateRequest": {
"type": "object",
"required": [
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

srikar-methodfi
merged 1 commit into

from

Aug 12, 2026
 Merged


chore: add files api + raw crpt artifacts (connect) to openapi spec
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


277 changes: 271 additions & 6 deletions
latest/openapi.bundled.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
 "name": "Events",
 "description": "Webhook event log"
 },
 {
 "name": "Files",
 "description": "Downloadable artifacts generated by Method"
 },
 {
 "name": "Forwarding Requests",
 "description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
 "items": {
 "type": "string"
 }
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
 "enum": [
 "equifax",
 "transunion"
 ]
 },
 "artifacts": {
 "type": "array",
 "description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
 "items": {
 "type": "string",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 }
 }
 },
 "dependentRequired": {
 "artifacts": [
 "bureau"
 ]
 }
 }
 }
Expand DownExpand Up@@ -6097,6 +6125,127 @@
 }
 }
 },
 "/files/{fileId}": {
 "get": {
 "operationId": "retrieveFile",
 "summary": "Retrieve a file",
 "description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The requested file.",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/FileResponse"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/files/{fileId}/download": {
 "get": {
 "operationId": "downloadFile",
 "summary": "Download a file",
 "description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
 "headers": {
 "Content-Disposition": {
 "description": "Attachment filename for the downloaded file.",
 "schema": {
 "type": "string"
 }
 }
 },
 "content": {
 "application/json": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 },
 "application/pdf": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/forwarding_requests": {
 "post": {
 "operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
 "pattern": "^evt_\\w+$"
 }
 },
 "FileIdParam": {
 "name": "fileId",
 "in": "path",
 "required": true,
 "description": "Unique identifier for the file.",
 "schema": {
 "type": "string",
 "pattern": "^file_\\w+$"
 }
 },
 "expand_payments": {
 "name": "expand",
 "in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
 }
 }
 },
 "EntityConnectFile": {
 "type": "object",
 "description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
 "required": [
 "id",
 "type",
 "bureau",
 "mime_type"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau the file was generated from.",
 "enum": [
 "transunion",
 "equifax"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 }
 }
 },
 "ConnectResourceError": {
 "type": [
 "object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
 "accounts",
 "requested_products",
 "requested_subscriptions",
 "files",
 "created_at",
 "updated_at"
 ],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
 }
 },
 "files": {
 "type": [
 "array",
 "null"
 ],
 "description": "Files associated with this connect session (e.g. manual connect uploads).",
 "type": "array",
 "description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
 "items": {
 "$ref": "#/components/schemas/JsonObject"
 "$ref": "#/components/schemas/EntityConnectFile"
 }
 },
 "error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
 "message": null
 }
 },
 "File": {
 "type": "object",
 "description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
 "required": [
 "id",
 "type",
 "mime_type",
 "download_url",
 "download_expires_at",
 "created_at",
 "updated_at"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 },
 "download_url": {
 "type": "string",
 "format": "uri",
 "description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
 },
 "download_expires_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was created."
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was last updated."
 }
 }
 },
 "FileResponse": {
 "allOf": [
 {
 "$ref": "#/components/schemas/SuccessEnvelope"
 },
 {
 "type": "object",
 "properties": {
 "data": {
 "$ref": "#/components/schemas/File"
 }
 }
 }
 ]
 },
 "ForwardingRequestCreateRequest": {
 "type": "object",
 "required": [
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

srikar-methodfi
merged 1 commit into

from

Aug 12, 2026
 Merged


chore: add files api + raw crpt artifacts (connect) to openapi spec
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


277 changes: 271 additions & 6 deletions
latest/openapi.bundled.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
 "name": "Events",
 "description": "Webhook event log"
 },
 {
 "name": "Files",
 "description": "Downloadable artifacts generated by Method"
 },
 {
 "name": "Forwarding Requests",
 "description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
 "items": {
 "type": "string"
 }
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
 "enum": [
 "equifax",
 "transunion"
 ]
 },
 "artifacts": {
 "type": "array",
 "description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
 "items": {
 "type": "string",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 }
 }
 },
 "dependentRequired": {
 "artifacts": [
 "bureau"
 ]
 }
 }
 }
Expand DownExpand Up@@ -6097,6 +6125,127 @@
 }
 }
 },
 "/files/{fileId}": {
 "get": {
 "operationId": "retrieveFile",
 "summary": "Retrieve a file",
 "description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The requested file.",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/FileResponse"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/files/{fileId}/download": {
 "get": {
 "operationId": "downloadFile",
 "summary": "Download a file",
 "description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
 "headers": {
 "Content-Disposition": {
 "description": "Attachment filename for the downloaded file.",
 "schema": {
 "type": "string"
 }
 }
 },
 "content": {
 "application/json": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 },
 "application/pdf": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/forwarding_requests": {
 "post": {
 "operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
 "pattern": "^evt_\\w+$"
 }
 },
 "FileIdParam": {
 "name": "fileId",
 "in": "path",
 "required": true,
 "description": "Unique identifier for the file.",
 "schema": {
 "type": "string",
 "pattern": "^file_\\w+$"
 }
 },
 "expand_payments": {
 "name": "expand",
 "in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
 }
 }
 },
 "EntityConnectFile": {
 "type": "object",
 "description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
 "required": [
 "id",
 "type",
 "bureau",
 "mime_type"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau the file was generated from.",
 "enum": [
 "transunion",
 "equifax"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 }
 }
 },
 "ConnectResourceError": {
 "type": [
 "object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
 "accounts",
 "requested_products",
 "requested_subscriptions",
 "files",
 "created_at",
 "updated_at"
 ],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
 }
 },
 "files": {
 "type": [
 "array",
 "null"
 ],
 "description": "Files associated with this connect session (e.g. manual connect uploads).",
 "type": "array",
 "description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
 "items": {
 "$ref": "#/components/schemas/JsonObject"
 "$ref": "#/components/schemas/EntityConnectFile"
 }
 },
 "error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
 "message": null
 }
 },
 "File": {
 "type": "object",
 "description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
 "required": [
 "id",
 "type",
 "mime_type",
 "download_url",
 "download_expires_at",
 "created_at",
 "updated_at"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 },
 "download_url": {
 "type": "string",
 "format": "uri",
 "description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
 },
 "download_expires_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was created."
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was last updated."
 }
 }
 },
 "FileResponse": {
 "allOf": [
 {
 "$ref": "#/components/schemas/SuccessEnvelope"
 },
 {
 "type": "object",
 "properties": {
 "data": {
 "$ref": "#/components/schemas/File"
 }
 }
 }
 ]
 },
 "ForwardingRequestCreateRequest": {
 "type": "object",
 "required": [
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

srikar-methodfi
merged 1 commit into

from

Aug 12, 2026
 Merged


chore: add files api + raw crpt artifacts (connect) to openapi spec
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


277 changes: 271 additions & 6 deletions
latest/openapi.bundled.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
 "name": "Events",
 "description": "Webhook event log"
 },
 {
 "name": "Files",
 "description": "Downloadable artifacts generated by Method"
 },
 {
 "name": "Forwarding Requests",
 "description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
 "items": {
 "type": "string"
 }
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
 "enum": [
 "equifax",
 "transunion"
 ]
 },
 "artifacts": {
 "type": "array",
 "description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
 "items": {
 "type": "string",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 }
 }
 },
 "dependentRequired": {
 "artifacts": [
 "bureau"
 ]
 }
 }
 }
Expand DownExpand Up@@ -6097,6 +6125,127 @@
 }
 }
 },
 "/files/{fileId}": {
 "get": {
 "operationId": "retrieveFile",
 "summary": "Retrieve a file",
 "description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The requested file.",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/FileResponse"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/files/{fileId}/download": {
 "get": {
 "operationId": "downloadFile",
 "summary": "Download a file",
 "description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
 "headers": {
 "Content-Disposition": {
 "description": "Attachment filename for the downloaded file.",
 "schema": {
 "type": "string"
 }
 }
 },
 "content": {
 "application/json": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 },
 "application/pdf": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/forwarding_requests": {
 "post": {
 "operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
 "pattern": "^evt_\\w+$"
 }
 },
 "FileIdParam": {
 "name": "fileId",
 "in": "path",
 "required": true,
 "description": "Unique identifier for the file.",
 "schema": {
 "type": "string",
 "pattern": "^file_\\w+$"
 }
 },
 "expand_payments": {
 "name": "expand",
 "in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
 }
 }
 },
 "EntityConnectFile": {
 "type": "object",
 "description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
 "required": [
 "id",
 "type",
 "bureau",
 "mime_type"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau the file was generated from.",
 "enum": [
 "transunion",
 "equifax"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 }
 }
 },
 "ConnectResourceError": {
 "type": [
 "object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
 "accounts",
 "requested_products",
 "requested_subscriptions",
 "files",
 "created_at",
 "updated_at"
 ],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
 }
 },
 "files": {
 "type": [
 "array",
 "null"
 ],
 "description": "Files associated with this connect session (e.g. manual connect uploads).",
 "type": "array",
 "description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
 "items": {
 "$ref": "#/components/schemas/JsonObject"
 "$ref": "#/components/schemas/EntityConnectFile"
 }
 },
 "error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
 "message": null
 }
 },
 "File": {
 "type": "object",
 "description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
 "required": [
 "id",
 "type",
 "mime_type",
 "download_url",
 "download_expires_at",
 "created_at",
 "updated_at"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 },
 "download_url": {
 "type": "string",
 "format": "uri",
 "description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
 },
 "download_expires_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was created."
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was last updated."
 }
 }
 },
 "FileResponse": {
 "allOf": [
 {
 "$ref": "#/components/schemas/SuccessEnvelope"
 },
 {
 "type": "object",
 "properties": {
 "data": {
 "$ref": "#/components/schemas/File"
 }
 }
 }
 ]
 },
 "ForwardingRequestCreateRequest": {
 "type": "object",
 "required": [
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

srikar-methodfi
merged 1 commit into

from

Aug 12, 2026
 Merged


chore: add files api + raw crpt artifacts (connect) to openapi spec
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


277 changes: 271 additions & 6 deletions
latest/openapi.bundled.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
 "name": "Events",
 "description": "Webhook event log"
 },
 {
 "name": "Files",
 "description": "Downloadable artifacts generated by Method"
 },
 {
 "name": "Forwarding Requests",
 "description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
 "items": {
 "type": "string"
 }
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
 "enum": [
 "equifax",
 "transunion"
 ]
 },
 "artifacts": {
 "type": "array",
 "description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
 "items": {
 "type": "string",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 }
 }
 },
 "dependentRequired": {
 "artifacts": [
 "bureau"
 ]
 }
 }
 }
Expand DownExpand Up@@ -6097,6 +6125,127 @@
 }
 }
 },
 "/files/{fileId}": {
 "get": {
 "operationId": "retrieveFile",
 "summary": "Retrieve a file",
 "description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The requested file.",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/FileResponse"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/files/{fileId}/download": {
 "get": {
 "operationId": "downloadFile",
 "summary": "Download a file",
 "description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
 "headers": {
 "Content-Disposition": {
 "description": "Attachment filename for the downloaded file.",
 "schema": {
 "type": "string"
 }
 }
 },
 "content": {
 "application/json": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 },
 "application/pdf": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/forwarding_requests": {
 "post": {
 "operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
 "pattern": "^evt_\\w+$"
 }
 },
 "FileIdParam": {
 "name": "fileId",
 "in": "path",
 "required": true,
 "description": "Unique identifier for the file.",
 "schema": {
 "type": "string",
 "pattern": "^file_\\w+$"
 }
 },
 "expand_payments": {
 "name": "expand",
 "in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
 }
 }
 },
 "EntityConnectFile": {
 "type": "object",
 "description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
 "required": [
 "id",
 "type",
 "bureau",
 "mime_type"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau the file was generated from.",
 "enum": [
 "transunion",
 "equifax"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 }
 }
 },
 "ConnectResourceError": {
 "type": [
 "object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
 "accounts",
 "requested_products",
 "requested_subscriptions",
 "files",
 "created_at",
 "updated_at"
 ],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
 }
 },
 "files": {
 "type": [
 "array",
 "null"
 ],
 "description": "Files associated with this connect session (e.g. manual connect uploads).",
 "type": "array",
 "description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
 "items": {
 "$ref": "#/components/schemas/JsonObject"
 "$ref": "#/components/schemas/EntityConnectFile"
 }
 },
 "error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
 "message": null
 }
 },
 "File": {
 "type": "object",
 "description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
 "required": [
 "id",
 "type",
 "mime_type",
 "download_url",
 "download_expires_at",
 "created_at",
 "updated_at"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 },
 "download_url": {
 "type": "string",
 "format": "uri",
 "description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
 },
 "download_expires_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was created."
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was last updated."
 }
 }
 },
 "FileResponse": {
 "allOf": [
 {
 "$ref": "#/components/schemas/SuccessEnvelope"
 },
 {
 "type": "object",
 "properties": {
 "data": {
 "$ref": "#/components/schemas/File"
 }
 }
 }
 ]
 },
 "ForwardingRequestCreateRequest": {
 "type": "object",
 "required": [
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

srikar-methodfi
merged 1 commit into

from

Aug 12, 2026
 Merged


chore: add files api + raw crpt artifacts (connect) to openapi spec
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


277 changes: 271 additions & 6 deletions
latest/openapi.bundled.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
 "name": "Events",
 "description": "Webhook event log"
 },
 {
 "name": "Files",
 "description": "Downloadable artifacts generated by Method"
 },
 {
 "name": "Forwarding Requests",
 "description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
 "items": {
 "type": "string"
 }
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
 "enum": [
 "equifax",
 "transunion"
 ]
 },
 "artifacts": {
 "type": "array",
 "description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
 "items": {
 "type": "string",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 }
 }
 },
 "dependentRequired": {
 "artifacts": [
 "bureau"
 ]
 }
 }
 }
Expand DownExpand Up@@ -6097,6 +6125,127 @@
 }
 }
 },
 "/files/{fileId}": {
 "get": {
 "operationId": "retrieveFile",
 "summary": "Retrieve a file",
 "description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The requested file.",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/FileResponse"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/files/{fileId}/download": {
 "get": {
 "operationId": "downloadFile",
 "summary": "Download a file",
 "description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
 "headers": {
 "Content-Disposition": {
 "description": "Attachment filename for the downloaded file.",
 "schema": {
 "type": "string"
 }
 }
 },
 "content": {
 "application/json": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 },
 "application/pdf": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/forwarding_requests": {
 "post": {
 "operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
 "pattern": "^evt_\\w+$"
 }
 },
 "FileIdParam": {
 "name": "fileId",
 "in": "path",
 "required": true,
 "description": "Unique identifier for the file.",
 "schema": {
 "type": "string",
 "pattern": "^file_\\w+$"
 }
 },
 "expand_payments": {
 "name": "expand",
 "in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
 }
 }
 },
 "EntityConnectFile": {
 "type": "object",
 "description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
 "required": [
 "id",
 "type",
 "bureau",
 "mime_type"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau the file was generated from.",
 "enum": [
 "transunion",
 "equifax"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 }
 }
 },
 "ConnectResourceError": {
 "type": [
 "object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
 "accounts",
 "requested_products",
 "requested_subscriptions",
 "files",
 "created_at",
 "updated_at"
 ],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
 }
 },
 "files": {
 "type": [
 "array",
 "null"
 ],
 "description": "Files associated with this connect session (e.g. manual connect uploads).",
 "type": "array",
 "description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
 "items": {
 "$ref": "#/components/schemas/JsonObject"
 "$ref": "#/components/schemas/EntityConnectFile"
 }
 },
 "error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
 "message": null
 }
 },
 "File": {
 "type": "object",
 "description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
 "required": [
 "id",
 "type",
 "mime_type",
 "download_url",
 "download_expires_at",
 "created_at",
 "updated_at"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 },
 "download_url": {
 "type": "string",
 "format": "uri",
 "description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
 },
 "download_expires_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was created."
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was last updated."
 }
 }
 },
 "FileResponse": {
 "allOf": [
 {
 "$ref": "#/components/schemas/SuccessEnvelope"
 },
 {
 "type": "object",
 "properties": {
 "data": {
 "$ref": "#/components/schemas/File"
 }
 }
 }
 ]
 },
 "ForwardingRequestCreateRequest": {
 "type": "object",
 "required": [
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

srikar-methodfi
merged 1 commit into

from

Aug 12, 2026
 Merged


chore: add files api + raw crpt artifacts (connect) to openapi spec
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


277 changes: 271 additions & 6 deletions
latest/openapi.bundled.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
 "name": "Events",
 "description": "Webhook event log"
 },
 {
 "name": "Files",
 "description": "Downloadable artifacts generated by Method"
 },
 {
 "name": "Forwarding Requests",
 "description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
 "items": {
 "type": "string"
 }
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
 "enum": [
 "equifax",
 "transunion"
 ]
 },
 "artifacts": {
 "type": "array",
 "description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
 "items": {
 "type": "string",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 }
 }
 },
 "dependentRequired": {
 "artifacts": [
 "bureau"
 ]
 }
 }
 }
Expand DownExpand Up@@ -6097,6 +6125,127 @@
 }
 }
 },
 "/files/{fileId}": {
 "get": {
 "operationId": "retrieveFile",
 "summary": "Retrieve a file",
 "description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The requested file.",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/FileResponse"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/files/{fileId}/download": {
 "get": {
 "operationId": "downloadFile",
 "summary": "Download a file",
 "description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
 "headers": {
 "Content-Disposition": {
 "description": "Attachment filename for the downloaded file.",
 "schema": {
 "type": "string"
 }
 }
 },
 "content": {
 "application/json": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 },
 "application/pdf": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/forwarding_requests": {
 "post": {
 "operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
 "pattern": "^evt_\\w+$"
 }
 },
 "FileIdParam": {
 "name": "fileId",
 "in": "path",
 "required": true,
 "description": "Unique identifier for the file.",
 "schema": {
 "type": "string",
 "pattern": "^file_\\w+$"
 }
 },
 "expand_payments": {
 "name": "expand",
 "in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
 }
 }
 },
 "EntityConnectFile": {
 "type": "object",
 "description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
 "required": [
 "id",
 "type",
 "bureau",
 "mime_type"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau the file was generated from.",
 "enum": [
 "transunion",
 "equifax"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 }
 }
 },
 "ConnectResourceError": {
 "type": [
 "object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
 "accounts",
 "requested_products",
 "requested_subscriptions",
 "files",
 "created_at",
 "updated_at"
 ],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
 }
 },
 "files": {
 "type": [
 "array",
 "null"
 ],
 "description": "Files associated with this connect session (e.g. manual connect uploads).",
 "type": "array",
 "description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
 "items": {
 "$ref": "#/components/schemas/JsonObject"
 "$ref": "#/components/schemas/EntityConnectFile"
 }
 },
 "error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
 "message": null
 }
 },
 "File": {
 "type": "object",
 "description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
 "required": [
 "id",
 "type",
 "mime_type",
 "download_url",
 "download_expires_at",
 "created_at",
 "updated_at"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 },
 "download_url": {
 "type": "string",
 "format": "uri",
 "description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
 },
 "download_expires_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was created."
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was last updated."
 }
 }
 },
 "FileResponse": {
 "allOf": [
 {
 "$ref": "#/components/schemas/SuccessEnvelope"
 },
 {
 "type": "object",
 "properties": {
 "data": {
 "$ref": "#/components/schemas/File"
 }
 }
 }
 ]
 },
 "ForwardingRequestCreateRequest": {
 "type": "object",
 "required": [
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
chore: add files api + raw crpt artifacts (connect) to openapi spec#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

srikar-methodfi
merged 1 commit into

from

Aug 12, 2026
 Merged


chore: add files api + raw crpt artifacts (connect) to openapi spec
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


277 changes: 271 additions & 6 deletions
latest/openapi.bundled.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -145,6 +145,10 @@
 "name": "Events",
 "description": "Webhook event log"
 },
 {
 "name": "Files",
 "description": "Downloadable artifacts generated by Method"
 },
 {
 "name": "Forwarding Requests",
 "description": "Request forwarding with sensitive data injection"
Expand DownExpand Up@@ -4137,7 +4141,31 @@
 "items": {
 "type": "string"
 }
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau to pull the raw credit report from. Required when `artifacts` is set. Method configures which bureaus are permitted for your team; pulling from both bureaus requires two separate requests.",
 "enum": [
 "equifax",
 "transunion"
 ]
 },
 "artifacts": {
 "type": "array",
 "description": "Credit report artifacts to generate for this connect session. Each artifact is returned as a file in the `files` array of the response and can be downloaded through the Files API. Requires `bureau`. Raw credit report access is a restricted feature enabled per team.",
 "items": {
 "type": "string",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 }
 }
 },
 "dependentRequired": {
 "artifacts": [
 "bureau"
 ]
 }
 }
 }
Expand DownExpand Up@@ -6097,6 +6125,127 @@
 }
 }
 },
 "/files/{fileId}": {
 "get": {
 "operationId": "retrieveFile",
 "summary": "Retrieve a file",
 "description": "Returns a single file by its identifier, including a temporary pre-signed `download_url`. A fresh URL is generated on every retrieve.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The requested file.",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/FileResponse"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/files/{fileId}/download": {
 "get": {
 "operationId": "downloadFile",
 "summary": "Download a file",
 "description": "Returns the raw contents of the file as an attachment. Use this endpoint for direct access to the file. To obtain a pre-signed link instead, use the retrieve endpoint and read `download_url`.",
 "tags": [
 "Files"
 ],
 "security": [
 {
 "SecretKey": []
 }
 ],
 "parameters": [
 {
 "$ref": "#/components/parameters/method_version"
 },
 {
 "$ref": "#/components/parameters/FileIdParam"
 }
 ],
 "responses": {
 "200": {
 "description": "The raw file contents. The `Content-Type` header matches the file's `mime_type`.",
 "headers": {
 "Content-Disposition": {
 "description": "Attachment filename for the downloaded file.",
 "schema": {
 "type": "string"
 }
 }
 },
 "content": {
 "application/json": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 },
 "application/pdf": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "400": {
 "$ref": "#/components/responses/BadRequest"
 },
 "401": {
 "$ref": "#/components/responses/Unauthorized"
 },
 "403": {
 "$ref": "#/components/responses/Forbidden"
 },
 "404": {
 "$ref": "#/components/responses/NotFound"
 },
 "429": {
 "$ref": "#/components/responses/RateLimited"
 },
 "500": {
 "$ref": "#/components/responses/InternalError"
 }
 }
 }
 },
 "/forwarding_requests": {
 "post": {
 "operationId": "createForwardingRequest",
Expand DownExpand Up@@ -9844,6 +9993,16 @@
 "pattern": "^evt_\\w+$"
 }
 },
 "FileIdParam": {
 "name": "fileId",
 "in": "path",
 "required": true,
 "description": "Unique identifier for the file.",
 "schema": {
 "type": "string",
 "pattern": "^file_\\w+$"
 }
 },
 "expand_payments": {
 "name": "expand",
 "in": "query",
Expand DownExpand Up@@ -15157,6 +15316,45 @@
 }
 }
 },
 "EntityConnectFile": {
 "type": "object",
 "description": "A reference to a file generated for a connect session, along with the contextual metadata describing how it was produced.",
 "required": [
 "id",
 "type",
 "bureau",
 "mime_type"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file. Retrieve the file through the Files API to obtain a download URL.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "bureau": {
 "type": "string",
 "description": "The credit bureau the file was generated from.",
 "enum": [
 "transunion",
 "equifax"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 }
 }
 },
 "ConnectResourceError": {
 "type": [
 "object",
Expand DownExpand Up@@ -15214,6 +15412,7 @@
 "accounts",
 "requested_products",
 "requested_subscriptions",
 "files",
 "created_at",
 "updated_at"
 ],
Expand DownExpand Up@@ -15278,13 +15477,10 @@
 }
 },
 "files": {
 "type": [
 "array",
 "null"
 ],
 "description": "Files associated with this connect session (e.g. manual connect uploads).",
 "type": "array",
 "description": "Credit report artifacts generated for this connect session. Only populated when `artifacts` are requested on creation. Retrieve or download a file's contents through the Files API.",
 "items": {
 "$ref": "#/components/schemas/JsonObject"
 "$ref": "#/components/schemas/EntityConnectFile"
 }
 },
 "error": {
Expand DownExpand Up@@ -17333,6 +17529,75 @@
 "message": null
 }
 },
 "File": {
 "type": "object",
 "description": "A File is a downloadable artifact generated by Method. Files cannot be created directly. They are produced as a result of other API requests and are referenced by the resource that generated them.",
 "required": [
 "id",
 "type",
 "mime_type",
 "download_url",
 "download_expires_at",
 "created_at",
 "updated_at"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "Unique identifier for the file.",
 "pattern": "^file_\\w+$",
 "example": "file_jZWkPMhXPeYAn"
 },
 "type": {
 "type": "string",
 "description": "The type of artifact this file contains.",
 "enum": [
 "raw_credit_report",
 "credit_report_pdf"
 ]
 },
 "mime_type": {
 "type": "string",
 "description": "The content type of the file, e.g. `application/json` or `application/pdf`.",
 "example": "application/json"
 },
 "download_url": {
 "type": "string",
 "format": "uri",
 "description": "A temporary, pre-signed URL to the file's contents. A new URL is generated on every retrieve."
 },
 "download_expires_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when `download_url` expires. URLs are valid for 60 minutes (3600 seconds) by default. Retrieve the file again to receive a fresh URL."
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was created."
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the file was last updated."
 }
 }
 },
 "FileResponse": {
 "allOf": [
 {
 "$ref": "#/components/schemas/SuccessEnvelope"
 },
 {
 "type": "object",
 "properties": {
 "data": {
 "$ref": "#/components/schemas/File"
 }
 }
 }
 ]
 },
 "ForwardingRequestCreateRequest": {
 "type": "object",
 "required": [
Expand Down
Loading
Loading