OpenAPI Specification
openapi: 3.1.0
info:
title: Method Account Attributes Entity Consent API
version: '2025-12-01'
license:
name: Proprietary
url: https://methodfi.com
description: "The Method API enables you to retrieve financial data, create payments, and manage\nentities and accounts programmatically. This specification covers the public API\nsurface for version `2025-12-01`.\n\n## Authentication\n\nMost API requests require a Bearer token in the `Authorization` header.\nUse your secret key (`sk_...`) for server-side requests and public key (`pk_...`)\nfor client-side Element requests. Public Message-Level Encryption key discovery\nendpoints are documented separately and do not require authentication.\n\n## Versioning\n\nThe API version is selected via the `Method-Version` header. This spec targets\nversion `2025-12-01`. The SDK sets this header automatically.\n\n## Response Envelope\n\nMost JSON responses are wrapped in a standard envelope:\n\n```json\n{\n \"success\": true,\n \"data\": { ... },\n \"message\": null\n}\n```\n\nThe `/.well-known/jwks.json` endpoint is an exception and returns a bare JWK set.\n\n## Pagination\n\nList endpoints return pagination metadata in response headers:\n`Pagination-Page`, `Pagination-Page-Count`, `Pagination-Page-Limit`,\n`Pagination-Total-Count`, `Pagination-Page-Cursor-Prev`, `Pagination-Page-Cursor-Next`.\n\n## Expandable Fields\n\nCertain resource fields can be expanded from IDs to full objects using the\n`expand` query parameter. Maximum nesting depth is 4 levels.\n"
contact:
name: Method Financial
url: https://methodfi.com
email: team@methodfi.com
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development
security:
- SecretKey: []
tags:
- name: Entity Consent
description: Consent management for entities
paths:
/entities/{entityId}/consent:
post:
operationId: updateEntityConsent
summary: Update entity consent
description: Grants or withdraws consent for the specified entity.
tags:
- Entity Consent
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/EntityIdParam'
- $ref: '#/components/parameters/idempotency_key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEntityConsentRequest'
example:
type: withdraw
reason: entity_withdrew_consent
responses:
'200':
description: The updated entity.
content:
application/json:
schema:
$ref: '#/components/schemas/EntityResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
components:
schemas:
ErrorObject:
type: object
required:
- type
- code
- message
properties:
type:
type: string
description: Error type category.
enum:
- invalid_request
- api_error
- resource_error
code:
type: integer
description: Numeric error code. Common codes include 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 422 (unprocessable entity), 429 (rate limited), and 500 (internal error).
sub_type:
type:
- string
- 'null'
description: More specific error classification.
message:
type: string
description: Human-readable error description.
VerificationSessionResourceError:
type:
- object
- 'null'
description: Error details when an entity verification session fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of verification session error.
enum:
- VERIFICATION_SESSION_FAILED
code:
type: integer
description: Numeric error code (19XXX range).
enum:
- 19001
- 19002
- 19003
- 19004
sub_type:
type: string
description: Specific verification session error classification.
enum:
- VERIFICATION_SESSION_EXPIRED
- VERIFICATION_SESSION_INCORRECT_SMS_CODE
- VERIFICATION_SESSION_FAILED_SNA
- VERIFICATION_SESSION_FAILED_INVALID_ANSWER
message:
type: string
description: Human-readable error description.
example:
type: VERIFICATION_SESSION_FAILED
code: 19001
sub_type: VERIFICATION_SESSION_EXPIRED
message: The verification session has expired. Please re-initiate the verification process.
EntityIndividual:
type:
- object
- 'null'
properties:
first_name:
type:
- string
- 'null'
description: First name of the individual.
last_name:
type:
- string
- 'null'
description: Last name of the individual.
phone:
type:
- string
- 'null'
description: Phone number of the individual.
pattern: ^\+\d{10,15}$
example: '+15121231111'
email:
type:
- string
- 'null'
description: Email address of the individual.
format: email
dob:
type:
- string
- 'null'
format: date
description: Date of birth of the individual (YYYY-MM-DD).
ssn:
type:
- string
- 'null'
description: Social security number (masked).
ssn_4:
type:
- string
- 'null'
description: Last 4 digits of SSN (masked).
EntityConnect:
type: object
required:
- id
- entity_id
- status
- accounts
- requested_products
- requested_subscriptions
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the connect session.
example: cxn_iENwGBMDnr7sJ
entity_id:
type: string
description: The ID of the entity this connect session belongs to.
example: ent_au22b1fbFJbp8
status:
type: string
description: Status of the connect session.
enum:
- completed
- in_progress
- pending
- failed
accounts:
type: array
items:
title: EntityConnectExpandableAccount
oneOf:
- type: string
pattern: ^acc_\w+$
- $ref: '#/components/schemas/Account'
description: Expandable. List of account IDs connected through this session.
requested_products:
type:
- array
- 'null'
description: Products requested for this connect session.
items:
type: string
requested_subscriptions:
type:
- array
- 'null'
description: Subscriptions requested for this connect session.
items:
type: string
error:
type:
- object
- 'null'
description: Error details if the resource encountered an error.
allOf:
- $ref: '#/components/schemas/ConnectResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the connect session was created.
updated_at:
type: string
format: date-time
description: Timestamp when the connect session was last updated.
UpdateResourceError:
type:
- object
- 'null'
description: Error details when an account update fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of update error.
enum:
- UPDATE_FAILED
code:
type: integer
description: Numeric error code (21XXX range).
enum:
- 21001
sub_type:
type: string
description: Specific update error classification.
enum:
- UPDATE_TEMPORARILY_UNAVAILABLE
message:
type: string
description: Human-readable error description.
example:
type: UPDATE_FAILED
code: 21001
sub_type: UPDATE_TEMPORARILY_UNAVAILABLE
message: Update is temporarily unavailable for this account.
EntityExpandableVehicle:
title: EntityExpandableVehicle
description: Expandable. The entity vehicle ID or expanded vehicle object.
example: vhl_JMDEwMTY1Qw4c
oneOf:
- type: string
pattern: ^vhl_\w+$
- type: 'null'
- $ref: '#/components/schemas/EntityVehicle'
Address:
type: object
description: Postal mailing address.
properties:
line1:
type:
- string
- 'null'
description: Primary street address line.
example: 123 Main St
line2:
type:
- string
- 'null'
description: Secondary address line such as apartment or suite.
example: Apt 4B
city:
type:
- string
- 'null'
description: City or locality.
example: Austin
state:
type:
- string
- 'null'
description: Two-letter state or province code when available.
example: TX
zip:
type:
- string
- 'null'
description: Postal code.
example: '78701'
example:
line1: 123 Main St
line2: Apt 4B
city: Austin
state: TX
zip: '78701'
EntityIndividualResource:
allOf:
- $ref: '#/components/schemas/EntityBase'
- type: object
required:
- products
- restricted_products
- subscriptions
- available_subscriptions
- restricted_subscriptions
properties:
type:
type: string
enum:
- individual
individual:
$ref: '#/components/schemas/EntityIndividual'
verification:
$ref: '#/components/schemas/EntityVerification'
connect:
$ref: '#/components/schemas/EntityExpandableConnect'
credit_score:
$ref: '#/components/schemas/EntityExpandableCreditScore'
attribute:
$ref: '#/components/schemas/EntityExpandableAttribute'
vehicle:
$ref: '#/components/schemas/EntityExpandableVehicle'
products:
type: array
items:
type: string
description: Products currently active for this entity.
restricted_products:
type: array
items:
type: string
description: Products restricted for this entity.
subscriptions:
type: array
items:
type: string
description: Active subscriptions for this entity.
available_subscriptions:
type: array
items:
type: string
description: Subscriptions available for this entity.
restricted_subscriptions:
type: array
items:
type: string
description: Subscriptions restricted for this entity.
EntityVerificationSession:
type: object
required:
- id
- entity_id
- status
- type
- method
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the verification session.
example: evf_TRUJMEr8kn3Nh
entity_id:
type: string
description: The ID of the entity this verification session belongs to.
example: ent_au22b1fbFJbp8
status:
type: string
description: Current status of the verification session.
enum:
- pending
- in_progress
- verified
- failed
type:
type: string
description: The type of verification being performed.
enum:
- identity
- phone
method:
type:
- string
- 'null'
description: The verification method used.
enum:
- sms
- sna
- byo_sms
- byo_kyc
- kba
- element
- opal
- method_verified
- null
error:
type:
- object
- 'null'
description: Error details if the resource encountered an error.
allOf:
- $ref: '#/components/schemas/VerificationSessionResourceError'
expired_at:
type:
- string
- 'null'
format: date-time
description: Timestamp when the verification session expired.
sms:
type:
- object
- 'null'
description: SMS verification details. Present when method is sms.
sna:
type:
- object
- 'null'
description: SNA verification details. Present when method is sna.
byo_sms:
type:
- object
- 'null'
description: BYO SMS verification details. Present when method is byo_sms.
byo_kyc:
type:
- object
- 'null'
description: BYO KYC verification details. Present when method is byo_kyc.
kba:
type:
- object
- 'null'
description: KBA verification details. Present when method is kba.
element:
type:
- object
- 'null'
description: Element verification details. Present when method is element.
opal:
type:
- object
- 'null'
description: Opal verification details. Present when method is opal.
created_at:
type: string
format: date-time
description: Timestamp when the verification session was created.
updated_at:
type: string
format: date-time
description: Timestamp when the verification session was last updated.
AccountSensitive:
type: object
description: Sensitive data for an account.
required:
- id
- account_id
- status
- type
- fields
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the sensitive record.
pattern: ^astv_\w+$
example: astv_aTJMbnCjw34yQ
account_id:
type: string
description: The account this sensitive data belongs to.
pattern: ^acc_\w+$
status:
type: string
description: Current status of the sensitive data request.
enum:
- completed
- pending
- failed
type:
type: string
description: The type of sensitive data.
fields:
type: array
description: List of sensitive data fields retrieved.
items:
type: object
properties:
name:
type: string
description: Name of the field.
value:
type: string
description: Value of the field.
error:
$ref: '#/components/schemas/AccountSensitiveResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the sensitive record was created.
updated_at:
type: string
format: date-time
description: Timestamp when the sensitive record was last updated.
EntityVerification:
type:
- object
- 'null'
properties:
identity:
$ref: '#/components/schemas/EntityVerificationIdentity'
phone:
$ref: '#/components/schemas/EntityVerificationPhone'
EntityCreditScore:
type: object
required:
- id
- entity_id
- status
- scores
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the credit score.
example: crs_pn4ca33GRnrJm
entity_id:
type: string
description: The ID of the entity this credit score belongs to.
example: ent_au22b1fbFJbp8
status:
type: string
description: Status of the credit score retrieval.
enum:
- completed
- in_progress
- pending
- failed
scores:
type:
- array
- 'null'
description: Array of credit score results.
items:
type: object
required:
- score
- source
- model
- factors
- created_at
properties:
score:
type:
- integer
- 'null'
description: The credit score value.
source:
type:
- string
- 'null'
description: The source of the credit score.
model:
type:
- string
- 'null'
description: The scoring model used.
factors:
type:
- array
- 'null'
description: Factors affecting the credit score.
items:
$ref: '#/components/schemas/EntityCreditScoreFactor'
created_at:
type: string
format: date-time
description: Timestamp when this score was generated.
error:
type:
- object
- 'null'
description: Error details if the resource encountered an error.
allOf:
- $ref: '#/components/schemas/CreditScoreResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the credit score was created.
updated_at:
type: string
format: date-time
description: Timestamp when the credit score was last updated.
PayoffResourceError:
type:
- object
- 'null'
description: Error details when a payoff sync fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of payoff error.
enum:
- PAYOFF_FAILED
code:
type: integer
description: Numeric error code (18XXX range).
enum:
- 18001
sub_type:
type: string
description: Specific payoff error classification.
enum:
- PAYOFF_TEMPORARILY_UNAVAILABLE
message:
type: string
description: Human-readable error description.
example:
type: PAYOFF_FAILED
code: 18001
sub_type: PAYOFF_TEMPORARILY_UNAVAILABLE
message: Payoff is temporarily unavailable for this account.
AccountExpandableBalance:
title: AccountExpandableBalance
description: 'The latest balance ID. This field is expandable. When expanded, returns the full AccountBalance object.
'
oneOf:
- type: string
pattern: ^bal_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountBalance'
Entity:
description: An Entity represents an individual or business profile within Method.
oneOf:
- $ref: '#/components/schemas/EntityIndividualResource'
- $ref: '#/components/schemas/EntityCorporationResource'
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/EntityIndividualResource'
corporation: '#/components/schemas/EntityCorporationResource'
c_corporation: '#/components/schemas/EntityCorporationResource'
s_corporation: '#/components/schemas/EntityCorporationResource'
llc: '#/components/schemas/EntityCorporationResource'
partnership: '#/components/schemas/EntityCorporationResource'
sole_proprietorship: '#/components/schemas/EntityCorporationResource'
EntityResourceError:
type:
- object
- 'null'
description: Error details when an entity is disabled or verification fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of entity error.
enum:
- ENTITY_DISABLED
- ENTITY_VERIFICATION_FAILED
code:
type: integer
description: Numeric error code (12XXX range).
enum:
- 12001
- 12002
- 12003
- 12004
- 12005
- 12006
- 12007
sub_type:
type: string
description: Specific entity error classification.
enum:
- ENTITY_UNAUTHORIZED_PAYMENT
- ENTITY_INVALID_DETAILS
- ENTITY_SSN_MISMATCH
- ENTITY_CONSENT_WITHDRAWN
- ENTITY_PENDING_KYC_REVIEW
- ENTITY_CANNOT_PERFORM_ACTION
message:
type: string
description: Human-readable error description.
example:
type: ENTITY_DISABLED
code: 12002
sub_type: ENTITY_INVALID_DETAILS
message: Entity was disabled due to invalid information.
EntityAttribute:
type: object
required:
- id
- entity_id
- status
- attributes
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the entity attribute.
example: attr_QwMjMDEwMTY1
entity_id:
type: string
description: The ID of the entity this attribute belongs to.
example: ent_au22b1fbFJbp8
status:
type: string
description: Status of the attribute retrieval.
enum:
- completed
- in_progress
- pending
- failed
attributes:
$ref: '#/components/schemas/EntityAttributeData'
error:
type:
- object
- 'null'
description: Error details if the resource encountered an error.
allOf:
- $ref: '#/components/schemas/ResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the attribute was created.
updated_at:
type: string
format: date-time
description: Timestamp when the attribute was last updated.
EntityExpandableConnect:
title: EntityExpandableConnect
description: Expandable. The entity connect session ID or expanded connect object.
example: cxn_iENwGBMDnr7sJ
oneOf:
- type: string
pattern: ^cxn_\w+$
- type: 'null'
- $ref: '#/components/schemas/EntityConnect'
EntityAttributeData:
type:
- object
- 'null'
description: Financial health and credit attribute data.
properties:
credit_health_credit_card_usage:
type:
- object
- 'null'
description: Credit card usage health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_derogatory_marks:
type:
- object
- 'null'
description: Derogatory marks health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_hard_inquiries:
type:
- object
- 'null'
description: Hard inquiries health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_soft_inquiries:
type:
- object
- 'null'
description: Soft inquiries health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_total_accounts:
type:
- object
- 'null'
description: Total accounts health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_open_accounts:
type:
- object
- 'null'
description: Open accounts health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_credit_age:
type:
- object
- 'null'
description: Credit age health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_payment_history:
type:
- object
- 'null'
description: Payment history health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
credit_health_entity_delinquent:
type:
- object
- 'null'
description: Entity delinquency health indicator.
properties:
value:
type:
- number
- 'null'
description: The attribute value.
rating:
type: string
description: Rating for this attribute.
metadata:
type:
- object
- 'null'
description: Additional metadata.
AccountVerificationSessionResourceError:
type:
- object
- 'null'
description: Error details when an account verification session fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of verification session error.
enum:
- ACCOUNT_VERIFICATION_SESSION_FAILED
code:
type: integer
description: Numeric error code (16XXX range).
enum:
- 16001
- 16002
- 16003
- 16004
sub_type:
type: string
description: Specific verification session error classification.
enum:
- VERIFICATION_TYPE_NOT_SUPPORTED
- INVALID_DETAILS
- VERIFICATION_SESSION_ATTEMPT_LIMIT_REACHED
- MICRO_DEPOSITS_FAILED
message:
type: string
description: Human-readable error description.
example:
type: ACCOUNT_VERIFICATION_SESSION_FAILED
code: 16001
sub_type: VERIFICATION_TYPE_NOT_SUPPORTED
message: The verification type provided is not supported for the merchant.
EntityVerificationPhone:
type: object
properties:
verified:
type: boolean
description: Whether the phone has been verified.
latest_verification_session:
title: EntityPhoneExpandableLatestVerificationSession
description: ID of the latest phone verification session. Expandable via `phone_latest_verification_session`.
oneOf:
- type: string
pattern: ^evf_\w+$
- type: 'null'
- $ref: '#/components/schemas/EntityVerificationSession'
methods:
type: array
items:
type: string
description: Available phone verification methods.
EntityResponse:
allOf:
- $ref: '#/components/schemas/SuccessEnvelope'
- type: object
properties:
data:
$ref: '#/components/schemas/Entity'
example:
success: true
data:
id: ent_au22b1fbFJbp8
type: individual
individual:
first_name: Jane
last_name: Doe
phone: '+15125550123'
email: jane@example.com
dob: '1990-05-21'
address:
line1: 123 Main St
line2: null
city: Austin
state: TX
zip: '78701'
verification:
identity:
verified: true
matched: true
latest_verification_session: evf_aBcDeFgHiJkLm
methods: []
phone:
verified: true
latest_verification_session: evf_nOpQrStUvWxYz
methods: []
connect: null
credit_score: null
attribute: null
vehicle: null
products:
- connect
- credit_score
restricted_products:
- attribute
- identity
- manual_connect
- vehicle
subscriptions: []
available_subscriptions:
- connect
- credit_score
restricted_subscriptions:
- attribute
status: active
error: null
metadata: null
created_at: '2024-12-05T10:05:21.742Z'
updated_at: '2024-12-05T10:11:17.823Z
# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/methodfi/refs/heads/main/openapi/methodfi-entity-consent-api-openapi.yml