Skip to content

Commit 47faf5d

Browse files
committed
docs: deprecate request options the API ignores
1 parent 3b3d6a8 commit 47faf5d

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,8 @@ status = client.poll_session(session["session_id"], session["poll_secret"])
5858
if status["status"] == "verified":
5959
print(status["operator_token"]) # "opc_...", use for future requests
6060

61-
# Optional pre-association: attach the session to a known wallet or refresh KYC
62-
# for an existing operator credential.
63-
client.create_session(address="0x...")
64-
client.create_session(operator_token="opc_...") # KYC refresh
65-
client.create_session(kind="sign_in") # registration-only: account sign-in, no identity documents
61+
# Registration-only session: the buyer signs in with an AgentScore account, no identity documents.
62+
client.create_session(kind="sign_in")
6663
```
6764

6865
### Wallet resolution

‎agentscore/client.py‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,9 @@ def assess(
257257
aip_token: str | None = None,
258258
aip_signature: AipSignatureMaterial | None = None,
259259
) -> AssessResponse:
260-
"""Assess a wallet or operator (paid, writes score on-the-fly).
260+
"""Assess a wallet or operator against a compliance policy.
261+
262+
``refresh`` is deprecated: the API ignores it, and every assess is evaluated live.
261263
262264
``signer`` opts into server-side wallet-signer-match: when supplied,
263265
the API resolves the signer wallet against the claimed ``address`` and emits
@@ -303,9 +305,8 @@ def create_session(
303305
) -> SessionCreateResponse:
304306
"""Create a verification or sign-in session.
305307
306-
``address`` pre-associates the session with a known wallet (EVM ``0x...`` or
307-
Solana base58). ``operator_token`` pre-associates with an existing ``opc_...``:
308-
e.g. refresh KYC for a credential. ``kind`` selects the session kind: ``"kyc"``
308+
``address`` and ``operator_token`` are deprecated: the API ignores them, so a
309+
session is never pre-associated with a wallet or credential. ``kind`` selects the session kind: ``"kyc"``
309310
(the API default) runs identity verification; ``"sign_in"`` is registration-only
310311
(the buyer signs in with an AgentScore account, no identity documents) and mints a
311312
``sign_in``-scoped credential, for merchants that key durable state on the account
@@ -406,7 +407,9 @@ async def aassess(
406407
aip_token: str | None = None,
407408
aip_signature: AipSignatureMaterial | None = None,
408409
) -> AssessResponse:
409-
"""Assess a wallet or operator (paid, writes score on-the-fly).
410+
"""Assess a wallet or operator against a compliance policy.
411+
412+
``refresh`` is deprecated: the API ignores it, and every assess is evaluated live.
410413
411414
``signer`` opts into server-side wallet-signer-match; ``aip_token`` (+ ``aip_signature``)
412415
supplies an AIP Agent Identity Token. Async mirror of :meth:`assess`.
@@ -445,9 +448,8 @@ async def acreate_session(
445448
) -> SessionCreateResponse:
446449
"""Create a verification or sign-in session.
447450
448-
``address`` pre-associates the session with a known wallet (EVM ``0x...`` or
449-
Solana base58). ``operator_token`` pre-associates with an existing ``opc_...``:
450-
e.g. refresh KYC for a credential. ``kind`` selects the session kind: ``"kyc"``
451+
``address`` and ``operator_token`` are deprecated: the API ignores them, so a
452+
session is never pre-associated with a wallet or credential. ``kind`` selects the session kind: ``"kyc"``
451453
(the API default) runs identity verification; ``"sign_in"`` is registration-only
452454
(the buyer signs in with an AgentScore account, no identity documents) and mints a
453455
``sign_in``-scoped credential, for merchants that key durable state on the account

0 commit comments

Comments
 (0)