Skip to content

Commit 571c196

Browse files
authored
Update docs for Discord and GitHub verifications from Warpcast API (base#416)
<!-- start pr-codex --> ## PR-Codex overview This PR updates the documentation for the `GET /fc/account-verifications` endpoint, clarifying its stability status and adding a new query parameter for platform filtering. ### Detailed summary - Updated stability note to indicate potential deprecation. - Added `platform` query parameter to limit response to specific platforms: `'x'`, `'github'`, or `'discord'`. - Expanded `platform` field description in the response to include `'github'` and `'discord'`. - Added an example response for a verification from `github`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
1 parent 8f78782 commit 571c196

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/reference/warpcast/api.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -959,18 +959,19 @@ curl -X DELETE \
959959

960960
`GET /fc/account-verifications`
961961

962-
### This endpoint is not stable (beta) and very likely to have breaking changes in the future.
962+
### This endpoint is not stable (beta) and likely to have breaking changes in the future or get depracated.
963963

964964
List of account verifications attested by Warpcast. Ordered by the time when the verification occurred, descending. Paginated. Not authenticated.
965965

966966
Query parameters:
967967

968968
- `fid` (**optional**) - limit the response to specific user
969+
- `platform` (**optional**) - limit the response to specific platform `'x' | 'github' | 'discord'`. Defaults to `'x'` for backwards compatibility.
969970

970971
Returns: a `verifications` array:
971972

972973
- `fid` - account Farcaster id
973-
- `platform` - platform of the verification `'x'`
974+
- `platform` - platform of the verification `'x' | 'github' | 'discord'`
974975
- `platformId` - string value representing platform identifier (generated by the platform, not Warpcast)
975976
- `platformUsername` - string value representing platform username
976977
- `verifiedAt` - UNIX time when verification took place, in seconds
@@ -986,6 +987,13 @@ Returns: a `verifications` array:
986987
"platformUsername": "dwr",
987988
"verifiedAt": 1728505748
988989
},
990+
{
991+
"fid": 3,
992+
"platform": "github",
993+
"platformId": "86492",
994+
"platformUsername": "danromero",
995+
"verifiedAt": 1728505748
996+
},
989997
...
990998
]
991999
},

0 commit comments

Comments
 (0)