Sharing Consumer Report data with partners

For eligible product use cases, Plaid Check provides the ability to share Consumer Reporting Agency (CRA) report information with approved partners (Fannie Mae, Freddie Mac, or Experian) using OAuth.

To share CRA report information with partners, you need to create an OAuth access token associated with a previously created user token that your partner can use to access the information.

To create an access token that will be provided to your partner, call /oauth/token following the example below.

For the subject_token, provide the user_token that you created using /user/create.

The audience must match the partner you are sharing with. Valid values are:

• urn:plaid:params:cra-partner:experian
• urn:plaid:params:cra-partner:fannie-mae
• urn:plaid:params:cra-partner:freddie-mac

You can also provide multiple comma-separated values to create a token that will work with multiple partners. For example: "audience": "urn:plaid:params:cra-partner:experian,urn:plaid:params:cra-partner:fannie-mae"

curl 'https://sandbox.plaid.com/oauth/token' \
--header 'Content-Type: application/json' \
--data '{
  "client_id": "${PLAID_CLIENT_ID}",
  "secret": "${PLAID_SECRET}",
  "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
  "scope": "user:read",
  "subject_token_type":"urn:plaid:params:credit:multi-user",
  "audience": "urn:plaid:params:cra-partner:fannie-mae",
  "subject_token": "user-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d"
}'

{
  "access_token": "pda-RDdg0TUCB0FB25_UPIlnhA==",
  "expires_in": 2591999,
  "refresh_token": "Rpdr--viXurkDg88d5zf8m6Wl0g==",
  "request_id": "vPamXI8hYXPl7P2",
  "token_type": "Bearer"
}

You can then provide the access_token to your partner.

To revoke your token, call /oauth/revoke, passing in the access_token and/or refresh_token as the token value.

curl -X POST https://sandbox.plaid.com/oauth/revoke \
-H 'Content-Type: application/json' \
-d '{
  "client_id": "${PLAID_CLIENT_ID}",
  "secret": "${PLAID_SECRET}",
  "token": "pda-RDdg0TUCB0FB25_UPIlnhA=="
}'

{
  "request_id": "pCDVCQK8ve2MzhM"
}