{ "item": [ { "name": "Agreements", "description": "", "item": [ { "id": "b68ca472-badd-5200-ba23-67b0b251a2ba", "name": "Get Latest Unaccepted Agreement", "request": { "name": "Get Latest Unaccepted Agreement", "description": { "content": "Get the latest unaccepted agreement for a specific agreement type", "type": "text/plain" }, "url": { "path": [ "agreements", "latest-unaccepted" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of agreement to look up. (This can only be one of PrivacyPolicy,TermsAndConditions,UniswapTermsOfService,UniswapPrivacyPolicy)", "type": "text/plain" }, "key": "agreementType", "value": "UniswapTermsOfService" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26619896-0887-5d4d-aa32-9a1b173ddac0", "name": "Record Agreement Acceptance", "request": { "name": "Record Agreement Acceptance", "description": { "content": "Record the acceptance of a specific agreement by its ID", "type": "text/plain" }, "url": { "path": [ "agreements", ":agreementId", "accept" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "agreementId", "disabled": false, "description": { "content": "(Required) ID of the agreement to accept.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "b49c417d-9b9a-5b6d-a590-c2aaa190a916" }, { "name": "Allocations", "description": "", "item": [ { "id": "ebdbaf53-a3f8-549c-adef-a2cbab11e94b", "name": "Create Allocation", "request": { "name": "Create Allocation", "description": { "content": "Create a new allocation.", "type": "text/plain" }, "url": { "path": [ "allocations" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"ext-123\",\n \"sourceAsset\": {\n \"kind\": \"Erc20\",\n \"contract\": \"0x6b175474e89094c44da98b954eedeac495271d0f\",\n \"amount\": \"1000000000000000000\"\n },\n \"targetAsset\": {\n \"kind\": \"Erc20\",\n \"contract\": \"0x5d3a536e4d6dbd6114cc1ead35777bab948e3643\",\n \"amount\": \"32000000000000000000\"\n },\n \"slippageBps\": 50,\n \"walletId\": \"wa-4g991-s29to-9hrq4nbuto6ih33b\",\n \"protocol\": \"0fns\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83dd5c4e-0dfc-5503-ad8c-c41ffe016d87", "name": "List Allocations", "request": { "name": "List Allocations", "description": {}, "url": { "path": [ "allocations" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf10782e-c2a0-527c-85c0-eb84bff958dd", "name": "Create Allocation Action", "request": { "name": "Create Allocation Action", "description": { "content": "Create a new action for an existing allocation.", "type": "text/plain" }, "url": { "path": [ "allocations", ":allocationId", "actions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "allocationId", "disabled": false, "description": { "content": "(Required) Unique identifier for the allocation investment.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Deposit\",\n \"sourceAsset\": {\n \"kind\": \"Erc20\",\n \"contract\": \"0x7BD656DD64b8cb2C3A778ADED30AaF5efc4D79cB\",\n \"amount\": \"80907230\"\n },\n \"targetAsset\": {\n \"kind\": \"Erc20\",\n \"contract\": \"0xebAfeAFFCDfAD9a1845e8a4d0d8D5b8E9D62E51a\",\n \"amount\": \"43\"\n },\n \"slippageBps\": 7719,\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9cafb08-8b21-5ef7-9541-0edfe82615af", "name": "List Allocation Actions", "request": { "name": "List Allocation Actions", "description": { "content": "Retrieve the list of actions for a specific allocation.", "type": "text/plain" }, "url": { "path": [ "allocations", ":allocationId", "actions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "allocationId", "disabled": false, "description": { "content": "(Required) Unique identifier for the allocation investment.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93e14072-3fd4-54c6-b37d-4c451da9b586", "name": "Get Allocation", "request": { "name": "Get Allocation", "description": { "content": "Retrieve the details of a specific allocation.", "type": "text/plain" }, "url": { "path": [ "allocations", ":allocationId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "allocationId", "disabled": false, "description": { "content": "(Required) Unique identifier for the allocation investment.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "ac6783bf-a8c4-5068-ace2-9392f4c46259" }, { "name": "Authentication", "description": "", "item": [ { "name": "Action Signing", "item": [ { "id": "7b16823c-8e17-5859-8815-33e455860965", "name": "Create User Action Signature", "request": { "name": "Create User Action Signature", "description": { "content": "Completes the user action signing process and provides a signing token that can be used to verify the user intended to perform the action.\n\nThis is the first step of the [User Action Signing flow](http://docs.dfns.co/api-reference/auth/signing-flows).\n\nThe type of credentials used to sign the action is determined by the `kind` field in the nested objects (`firstFactor` and `secondFactor`). Supported credential kinds are:\n* `Fido2`: User action is signed by a user's signing device using `WebAuthn`.\n* `Key`: User action is signed by a user's, or token's, private key.\n* `PasswordProtectedKey`: Login challenge is signed by the decrypted user's private key that was sent during [Create User Action Signature Challenge](https://docs.dfns.co/api-reference/auth/create-user-action-challenge) step.\n", "type": "text/plain" }, "url": { "path": [ "auth", "action" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"challengeIdentifier\": \"eyJ0e...fQNA\",\n \"firstFactor\": {\n \"kind\": \"Fido2\",\n \"credentialAssertion\": {\n \"credId\": \"c1QEdgnPLJargwzy3cbYKny4Q18u0hr97unXsF3DiE8\",\n \"clientData\": \"eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiTVdNME1tWTVZVFEwTURSaU56ZGhOVEZoTnpZNU9EUXdOV0k1WlRRNFkyUmhPRFppTkRrM1pUWXpPVEU1T0dZeU1EY3haakJqWXprNE1tUTVZelkxTUEiLCJvcmlnaW4iOiJodHRwczovL2FwcC5kZm5zLm5pbmphIiwiY3Jvc3NPcmlnaW4iOmZhbHNlfQ\",\n \"authenticatorData\": \"WT-zFZUBbJHfBkmhzTlPf49LTn7asLeTQKhm_riCvFgFAAAAAA\",\n \"signature\": \"MEUCIQDJ8G9J1NTjdoKx0yloYw45bpn6fJhcqCoUGiZuOU1IAQIgAtPt7S8FHFYW9OMHh3S5FVAxk-lhli-2lX22bBNSDog\",\n \"userHandle\": \"dXMtMmJhMGgtbHZwMnEtOHYxODYwcGNqMWJoNWlyaQ\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb3e2676-caff-5870-b93c-54b366586969", "name": "Create User Action Challenge", "request": { "name": "Create User Action Challenge", "description": { "content": "Starts a user action signing session, returning a challenge that will be used to verify the user's intent to perform an action.\n \n This is the first step of the [User Action Signing flow](http://docs.dfns.co/api-reference/auth/signing-flows).", "type": "text/plain" }, "url": { "path": [ "auth", "action", "init" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userActionPayload\": \"{\\\"name\\\": \\\"My PAT\\\",\\\"publicKey\\\": \\\"-----BEGIN PUBLIC KEY-----\\\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEZQt0YI2hdsFNmKJesSkAHldyPLIV\\\\nFLI/AhQ5eGasA7jU8tEXOb6nGvxRaTIXrgZ2NPdk78O8zMqz5u9AekH8jA==\\\\n-----END PUBLIC KEY-----\\\",\\\"daysValid\\\": 365,\\\"permissionId\\\": \\\"pm-delaw-avoca-v16r37fpp8koqebc\\\"}\",\n \"userActionHttpMethod\": \"POST\",\n \"userActionHttpPath\": \"/auth/pats\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7aeef15b-5773-5d20-b9bc-2a0bb93006df", "name": "List Audit Logs", "request": { "name": "List Audit Logs", "description": { "content": "\n Gets all signature events which have occurred in the over the timeframe. The time range is unbounded, but the export is capped at 100,000 rows. When the result is truncated, the `X-Dfns-Result-Truncated: true` response header is set and a trailing `# TRUNCATED ...` line is appended to the CSV; narrow the time range to retrieve all data.\n\nStartTime and EndTime are URL-encoded UTC ISO timestamps:\n`startTime=2025-08-29T02%3A46%3A40Z` \n`endTime=2025-09-01T02%3A46%3A40Z` \n\nAn additional optional query parameter, `userId` can be specified to filter down events to a particular user. The API will return results found in CSV format.\n\n\nDfns maintains a script which can be used for audit log signature validation: [WebAuthn Signature Verifier](https://github.com/dfns/example-scripts/tree/m/python/utils)\n\n", "type": "text/plain" }, "url": { "path": [ "auth", "action", "logs" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). Start of the range.", "type": "text/plain" }, "key": "startTime", "value": "1972-10-30T05:06:40.558Z" }, { "disabled": false, "description": { "content": "(Required) [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). End of the range. The export is capped at 100,000 rows.", "type": "text/plain" }, "key": "endTime", "value": "2000-05-23T12:47:28.118Z" }, { "disabled": true, "description": { "content": "Provide a user id to list events from that particular user only.", "type": "text/plain" }, "key": "userId", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad76c3ed-47a6-5361-87fa-a1d70423dfc8", "name": "Get Audit Log", "request": { "name": "Get Audit Log", "description": { "content": "\nGets detailed information for a particular audit log. Specifically, the API returns the action performed, as well as the `firstFactorCredential` in which you will find the signature information required to validate it. \n\nDfns maintains a script which can be used for audit log signature validation: [WebAuthn Signature Verifier](https://github.com/dfns/example-scripts/tree/m/python/utils)\n ", "type": "text/plain" }, "url": { "path": [ "auth", "action", "logs", ":id" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "uj-22lhj-mp2ir-88at3r4cufpis60i", "key": "id", "disabled": false, "description": { "content": "(Required) Log id you need information about.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "0c1f7500-c02f-5fa3-a39d-bc018d44ffb0" }, { "name": "Applications", "item": [ { "id": "5cb0f498-86ca-5744-9e7e-b5dd91282219", "name": "List Applications", "request": { "name": "List Applications", "description": { "content": "\n Applications are deprecated and will be removed in a future release. See details [here](https://docs.dfns.co/developers/guides/applications-deprecation).\n ", "type": "text/plain" }, "url": { "path": [ "auth", "apps" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb61c1e1-9d38-554a-a1db-3b00a4c43a3a", "name": "Get Application", "request": { "name": "Get Application", "description": { "content": "\n Applications are deprecated and will be removed in a future release. See details [here](https://docs.dfns.co/developers/guides/applications-deprecation).\n ", "type": "text/plain" }, "url": { "path": [ "auth", "apps", ":appId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "appId", "disabled": false, "description": { "content": "(Required) ID of the application (deprecated).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "b6cb20cf-a6b3-55e1-939d-35b6b1821aad" }, { "name": "Credentials", "item": [ { "id": "23bcc863-ba92-5c08-b531-09226f62c285", "name": "Create Credential", "request": { "name": "Create Credential", "description": { "content": "Part of the flow [Create Credential Regular flow](https://docs.dfns.co/api-reference/auth/credentials#regular-flow).\n\nAdds a new credential to a user's account. See [Credential Kinds](https://docs.dfns.co/api-reference/auth/credentials#credential-kinds) for all supported credential types.", "type": "text/plain" }, "url": { "path": [ "auth", "credentials" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\",\n \"challengeIdentifier\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce7f0bb0-37d3-5120-a63e-258a9de1fb05", "name": "List Credentials", "request": { "name": "List Credentials", "description": { "content": "List all credentials for a user.", "type": "text/plain" }, "url": { "path": [ "auth", "credentials" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42788627-3cf0-540e-9e2b-e9d2e22ce220", "name": "Create Credential Challenge", "request": { "name": "Create Credential Challenge", "description": { "content": "Part of the flow [Create Credential Regular flow](https://docs.dfns.co/api-reference/auth/credentials#regular-flow).\n \n Starts a create user credential session, returning a challenge that will be used to verify the user's identity.", "type": "text/plain" }, "url": { "path": [ "auth", "credentials", "init" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"RecoveryKey\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76283758-ea4f-5686-a895-32a0d1e8ae3a", "name": "Activate Credential", "request": { "name": "Activate Credential", "description": { "content": "Activates a credential that was previously deactivated. If the credential is already activated no action is taken.", "type": "text/plain" }, "url": { "path": [ "auth", "credentials", "activate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentialUuid\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11154077-d260-50a4-984f-0d3eb4f3a926", "name": "Delete Credential", "request": { "name": "Delete Credential", "description": { "content": "Delete a specific credential.", "type": "text/plain" }, "url": { "path": [ "auth", "credentials", ":credentialUuid" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "credentialUuid", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "588d2965-eaaa-5eba-b1f6-09a5b308244d", "name": "Deactivate Credential", "request": { "name": "Deactivate Credential", "description": { "content": "Deactivates a credential that was previously active. If the credential is already deactivated no action is taken.", "type": "text/plain" }, "url": { "path": [ "auth", "credentials", "deactivate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentialUuid\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfb028bf-ddc7-5d5a-a469-c04726e4cb99", "name": "Create Credential Code", "request": { "name": "Create Credential Code", "description": { "content": "Part of the [Create Credential With Code flow](https://docs.dfns.co/api-reference/auth/credentials#create-credential-with-code-flow).\n\nCreates a one-time-code that can then be used to create a new credential from a place you don't have access to one of your existing credential.", "type": "text/plain" }, "url": { "path": [ "auth", "credentials", "code" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expiration\": \"1995-09-16T02:27:35.819Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "632a854d-e3c3-5ff1-a4c9-71d51be067fa", "name": "Create Credential Challenge With Code", "request": { "name": "Create Credential Challenge With Code", "description": { "content": "Part of the flow [Create Credential With Code](https://docs.dfns.co/api-reference/auth/credentials#create-credential-with-code-flow).\n\nCreates a credential challenge using a one time code-time-code. This challenge must then be signed by the new credential, before finalizing the flow.\n", "type": "text/plain" }, "url": { "path": [ "auth", "credentials", "code", "init" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"credentialKind\": \"PasswordProtectedKey\",\n \"code\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0eee96d5-7ca6-5477-a735-e38eda02a836", "name": "Create Credential With Code", "request": { "name": "Create Credential With Code", "description": { "content": "Finalizes the flow [Create Credential With Code](https://docs.dfns.co/api-reference/auth/credentials#create-credential-with-code-flow).\n \nAdds a new credential to a user's account. This endpoint is similar to the [Create Credential](https://docs.dfns.co/api-reference/auth/create-credential) endpoint, except:\n* it does not need the user to be authenticated\n* it does not need user action signing\n* it will only work with the challenge gotten from the [Create Credential Challenge With Code](https://docs.dfns.co/api-reference/auth/create-credential-challenge-with-code) endpoint\n\n ", "type": "text/plain" }, "url": { "path": [ "auth", "credentials", "code", "verify" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\",\n \"challengeIdentifier\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "06e02caf-62cc-5bff-b5b3-7552311873ea" }, { "name": "Login", "item": [ { "id": "0044f47f-aaff-53bc-8ebb-9d43d8c0ed47", "name": "Create Login Challenge", "request": { "name": "Create Login Challenge", "description": { "content": "Start a user login session, returning a challenge that will be used to verify the user's identity.\n\nIf the user has a credential of kind `PasswordProtectedKey` a temporary one time code needs to be passed in the `loginCode` field.\n\nIf the user has at least one discoverable WebAuthn credential, `username` is optional (username-less flow).", "type": "text/plain" }, "url": { "path": [ "auth", "login", "init" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\",\n \"tenantId\": \"acct-24hka-dhili-9hgvdlvr1ohpibp4\",\n \"loginCode\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10fed56d-9b9e-5902-b5e1-3fc5dba47a7a", "name": "Delegated Login", "request": { "name": "Delegated Login", "description": { "content": "\n \nOnly a [Service Account](https://docs.dfns.co/api-reference/auth/service-accounts) can use this endpoint.\n\n\nLogs a user into an organization without the user's credentials.\n\nIf you want to use your own authentication system, while still using `Delegated Signing`, you can use this endpoint to authenticate a user without needing the user's credentials.\n\nThe user authentication token can be used for read operations within the Dfns API, however, write operations will still require the user to sign the action.\n", "type": "text/plain" }, "url": { "path": [ "auth", "login", "delegated" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97db2c36-e02c-5bf6-8ccd-471dae86cb09", "name": "Complete User Login", "request": { "name": "Complete User Login", "description": { "content": "Completes the login process and provides the authenticated user with their authentication token.\n\nThe type of credentials used to login is determined by the `kind` field in the nested objects (`firstFactor` and `secondFactor`). Supported credential kinds are:\n* `Fido2`: Login challenge is signed by a user's signing device using `WebAuthn`.\n* `Key`: Login challenge is signed by a user's private key.\n* `PasswordProtectedKey`: Login challenge is signed by the decrypted user's private key that was sent during [Create User Login Challenge](../registration/inituserregistration) step.\n", "type": "text/plain" }, "url": { "path": [ "auth", "login" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"challengeIdentifier\": \"string\",\n \"firstFactor\": {\n \"kind\": \"Fido2\",\n \"credentialAssertion\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"signature\": \"string\",\n \"authenticatorData\": \"string\",\n \"algorithm\": \"string\",\n \"userHandle\": \"string\"\n }\n },\n \"secondFactor\": {\n \"kind\": \"Fido2\",\n \"credentialAssertion\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"signature\": \"string\",\n \"authenticatorData\": \"string\",\n \"algorithm\": \"string\",\n \"userHandle\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "245caa59-c460-5f77-9e53-2b252a230b61", "name": "Logout", "request": { "name": "Logout", "description": { "content": "Completes the user logout process.", "type": "text/plain" }, "url": { "path": [ "auth", "logout" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"allSessions\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "682fb91d-21b3-5d12-81e9-3c6e4ca6e3b2", "name": "Send Login Code", "request": { "name": "Send Login Code", "description": { "content": "\n Sends a temporary one time code to the user that can be used during login flow.\n\nIf the user has a credential of kind `PasswordProtectedKey` a temporary one time code needs to be passed in the `loginCode` field. That's because the [Create Login Challenge](https://docs.dfns.co/api-reference/auth/create-login-challenge) is unauthenticated and returns the encrypted private key of the user. So we need a first step to verify the identity of the user to prevent anybody from fetching the encrypted private key and trying to brute force it offline.\n\n ", "type": "text/plain" }, "url": { "path": [ "auth", "login", "code" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\",\n \"tenantId\": \"acct-24hka-dhili-9hgvdlvr1ohpibp4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97547e32-f7e0-52d5-8a96-1e363e0024a5", "name": "Social Login", "request": { "name": "Social Login", "description": { "content": "Completes the login process and provides the authenticated user with their authentication token.", "type": "text/plain" }, "url": { "path": [ "auth", "login", "social" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"socialLoginProviderKind\": \"Oidc\",\n \"idToken\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24f7cbdd-92a6-5b30-b43b-812c72121782", "name": "Complete SSO Login", "request": { "name": "Complete SSO Login", "description": { "content": "Completes the login process and provides the authenticated user with their authentication token.", "type": "text/plain" }, "url": { "path": [ "auth", "login", "sso" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"state\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c53e2c0b-01fd-591a-9de8-ff6b0deb07d3", "name": "Initiate SSO Login", "request": { "name": "Initiate SSO Login", "description": { "content": "Initialize the login process with SSO by returning the IdP URL to call.", "type": "text/plain" }, "url": { "path": [ "auth", "login", "sso", "init" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\",\n \"clientId\": \"string\",\n \"redirectUri\": \"http://agnZedwPUbuIgDKJurhrWlGwo.hzAZbsQqGmhSHBmwlz451zbXCwdP1Povjg7Uy.TawwrBbo4xqZNjZBCn0+9h643aSwztqt-oNI\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "4e13fa17-6a4e-5de5-9b36-602f35b35960" }, { "name": "Personal Access Tokens", "item": [ { "id": "2debe925-389e-54a2-8919-beae1342af94", "name": "List Personal Access Tokens", "request": { "name": "List Personal Access Tokens", "description": { "content": "Retrieve the list of your Personal Access Tokens.", "type": "text/plain" }, "url": { "path": [ "auth", "pats" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af01c1ba-f95c-591d-84a8-8f087a7c2cd7", "name": "Create Personal Access Token", "request": { "name": "Create Personal Access Token", "description": { "content": "Create a new Personal Access Token for the caller.", "type": "text/plain" }, "url": { "path": [ "auth", "pats" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----l-----END PUBLIC KEY----- \",\n \"permissionId\": \"pm-37vj4-jkr4l-lc9945spfftkne57\",\n \"externalId\": \"string\",\n \"daysValid\": 6586,\n \"secondsValid\": 3208\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "506ed910-de4b-5221-8ecc-9fe7847f2385", "name": "Get Personal Access Token", "request": { "name": "Get Personal Access Token", "description": { "content": "Retrieve a specific Personal Access Token.", "type": "text/plain" }, "url": { "path": [ "auth", "pats", ":tokenId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "tokenId", "disabled": false, "description": { "content": "(Required) Token id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d7e18f7-92a3-506e-9e97-a589de01d2cb", "name": "Update Personal Access Token", "request": { "name": "Update Personal Access Token", "description": { "content": "Update a specific Personal Access Token.", "type": "text/plain" }, "url": { "path": [ "auth", "pats", ":tokenId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "tokenId", "disabled": false, "description": { "content": "(Required) Token id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e21b518-d05e-5c26-9534-c4dc0ed526e9", "name": "Delete Personal Access Token", "request": { "name": "Delete Personal Access Token", "description": { "content": "Delete a specific Personal Access Token.", "type": "text/plain" }, "url": { "path": [ "auth", "pats", ":tokenId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "tokenId", "disabled": false, "description": { "content": "(Required) Token id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff140028-bc54-5d91-bf19-a0ab7e8a6e20", "name": "Activate Personal Access Token", "request": { "name": "Activate Personal Access Token", "description": { "content": "Activate a specific Personal Access Token.", "type": "text/plain" }, "url": { "path": [ "auth", "pats", ":tokenId", "activate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "tokenId", "disabled": false, "description": { "content": "(Required) Token id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33e548a1-3b05-57b7-ab5d-91d47147d781", "name": "Deactivate Personal Access Token", "request": { "name": "Deactivate Personal Access Token", "description": { "content": "Deactivates a credential that was previously active. If the credential is already deactivated no action is taken.", "type": "text/plain" }, "url": { "path": [ "auth", "pats", ":tokenId", "deactivate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "tokenId", "disabled": false, "description": { "content": "(Required) Token id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "97aac55e-2acd-5a53-9682-73bb4d590f4d" }, { "name": "Access Recovery", "item": [ { "id": "83bbf0a8-3c71-51f5-ab53-30a5cf28e115", "name": "Create Delegated Recovery Challenge", "request": { "name": "Create Delegated Recovery Challenge", "description": { "content": "\n\nOnly a [Service Account](https://docs.dfns.co/api-reference/auth/service-accounts) can use this endpoint.\n\n\nStarts a recovery session for an end user under your brand, without sending a Dfns recovery email. Call this after you have verified the user's identity with your own auth system.\n\nThe response returns a recovery challenge. Pass it to your frontend so the user can decrypt their recovery credential and sign, then call [Recover User](https://docs.dfns.co/api-reference/auth/recover-user) to complete the recovery and register fresh credentials.\n", "type": "text/plain" }, "url": { "path": [ "auth", "recover", "user", "delegated" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"credentialId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a95b23e4-c968-5f16-b9a6-a9899ee795af", "name": "Recover User", "request": { "name": "Recover User", "description": { "content": "Recovers a user, using a recovery credential. After successfully recovering the user, all of the user's previous credentials and personal access tokens will be invalidated.\n\nThis flow requires cryptographic validation of newly created credential(s) using a recovery credential. The `recovery.credentialAssertion.clientData` field's challenge must be the _base64url-encoded_ representation of the `newCredential` object.\n\nThe process is as follows:\n\n1. Construct the `newCredential` object, using the challenge obtained from either the [Create Recovery Challenge](https://docs.dfns.co/api-reference/auth/create-recovery-challenge) or [Create Delegated Recovery Challenge](https://docs.dfns.co/api-reference/auth/create-delegated-recovery-challenge) endpoints.\n2. Serialize the `newCredential` object to JSON and then base64url-encode the resulting JSON string. This _base64url-encoded_ string will serve as the challenge for the `recovery.credentialAssertion` object.\n3. Construct the `recovery.credentialAssertion` object, using the _base64url-encoded_ string generated in step 2 as its challenge.\n", "type": "text/plain" }, "url": { "path": [ "auth", "recover", "user" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recovery\": {\n \"kind\": \"RecoveryKey\",\n \"credentialAssertion\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"signature\": \"string\",\n \"algorithm\": \"string\"\n }\n },\n \"newCredentials\": {\n \"firstFactorCredential\": {\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\"\n },\n \"secondFactorCredential\": {\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\"\n },\n \"recoveryCredential\": {\n \"credentialKind\": \"RecoveryKey\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"encryptedPrivateKey\": \"string\",\n \"credentialName\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c11658d6-2b58-5646-8caa-adbacd97ad91", "name": "Create Recovery Challenge", "request": { "name": "Create Recovery Challenge", "description": { "content": "Starts a user recovery session, returning a challenge that will be used to verify the user's identity.", "type": "text/plain" }, "url": { "path": [ "auth", "recover", "user", "init" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"verificationCode\": \"string\",\n \"credentialId\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\",\n \"tenantId\": \"acct-24hka-dhili-9hgvdlvr1ohpibp4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56c17894-ef1c-5463-abc9-f5f4f31398de", "name": "Send Recovery Code Email", "request": { "name": "Send Recovery Code Email", "description": { "content": "Send the user a recovery verification code. This code is used as a second factor to verify the user initiated the recovery request.", "type": "text/plain" }, "url": { "path": [ "auth", "recover", "user", "code" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\",\n \"tenantId\": \"acct-24hka-dhili-9hgvdlvr1ohpibp4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "9b671cbd-3d39-5030-932b-e9925a25f8ad" }, { "name": "Registration", "item": [ { "id": "4cee60f6-7fd4-5463-bf88-5b19488c8114", "name": "Create Delegated Registration Challenge", "request": { "name": "Create Delegated Registration Challenge", "description": { "content": "\nOnly a [Service Account](https://docs.dfns.co/api-reference/auth/service-accounts) can use this endpoint.\n\n\nRegisters a new End User in your organization and returns a registration challenge, without sending a Dfns registration email. Use this when your application owns the authentication system and you want delegated signing under your brand.\n\nThe response includes:\n1. A new `EndUser` attached to your organization.\n2. A registration challenge plus a `temporaryAuthenticationToken` to authenticate the next call.\n\nPass the challenge to your frontend so the user can create a passkey, then call [Complete User Registration](https://docs.dfns.co/api-reference/auth/complete-user-registration) or [Complete End User Registration with Wallets](https://docs.dfns.co/api-reference/auth/complete-end-user-registration-with-wallets) with that challenge signed.\n\nBundle a `recoveryCredential` in the completion call alongside the first passkey. All credentials in that call sign the same challenge returned here. See [Implement end-user recovery](https://docs.dfns.co/guides/developers/end-user-recovery).", "type": "text/plain" }, "url": { "path": [ "auth", "registration", "delegated" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"kind\": \"EndUser\",\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa4ee7e2-8bc1-535a-ae0e-18dd1b7f010c", "name": "Create Registration Challenge", "request": { "name": "Create Registration Challenge", "description": { "content": "Starts a user registration session. It returns a challenge that will need to be signed by a passkey and used to perform the step [Complete User Registration](/api-reference/auth/register)", "type": "text/plain" }, "url": { "path": [ "auth", "registration", "init" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"registrationCode\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\",\n \"tenantId\": \"acct-24hka-dhili-9hgvdlvr1ohpibp4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "235d83b8-8e00-5c0a-be35-37abfe359ec2", "name": "Create Social Registration Challenge", "request": { "name": "Create Social Registration Challenge", "description": { "content": "Starts an end-user registration session by passing a JWT obtained by an IdP. It returns a challenge that will need to be signed by a passkey and used to perform [Complete End User Registration with Wallets](/api-reference/auth/register-end-user).", "type": "text/plain" }, "url": { "path": [ "auth", "registration", "social" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"socialLoginProviderKind\": \"Oidc\",\n \"idToken\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8070121d-56ee-588f-a720-d882e0bb5de2", "name": "Complete User Registration", "request": { "name": "Complete User Registration", "description": { "content": "Completes the user registration process and creates the user's initial credentials.\n\nAll credentials submitted in this call (`firstFactorCredential`, `secondFactorCredential`, `recoveryCredential`) sign the same challenge returned by the registration init endpoint ([Create Registration Challenge](https://docs.dfns.co/api-reference/auth/create-registration-challenge), [Create Delegated Registration Challenge](https://docs.dfns.co/api-reference/auth/create-delegated-registration-challenge), or [Create Social Registration Challenge](https://docs.dfns.co/api-reference/auth/create-social-registration-challenge)).\n\nAlways include a `recoveryCredential` for end users. Without one, a user who loses their device cannot recover access and you must initiate a delegated recovery manually. See [Implement end-user recovery](https://docs.dfns.co/guides/developers/end-user-recovery).\n\nThe type of credentials being registered is determined by the `credentialKind` field in the nested objects (`firstFactorCredential` , `secondFactorCredential` and `recoveryCredential`). Supported credential kinds are:\n* `Fido2`: User action is signed by a user's signing device using `WebAuthn`.\n* `Key`: User action is signed by a user's, or token's, private key.\n* `PasswordProtectedKey`: User action is signed by a user's, or token's, private key. The encrypted version of the private key is stored by Dfns and returns during the signing flow for the user to decrypt it.\n* `RecoveryKey` : Similar to `PasswordProtectedKey`, but this credential can only be used to recover an account not to sign an action or login. Once this credential is used all the other user's credentials are invalidated.\n", "type": "text/plain" }, "url": { "path": [ "auth", "registration" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstFactorCredential\": {\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\"\n },\n \"secondFactorCredential\": {\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\"\n },\n \"recoveryCredential\": {\n \"credentialKind\": \"RecoveryKey\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"encryptedPrivateKey\": \"string\",\n \"credentialName\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88fc3992-aa1d-5fb4-9b54-e97a0a10aa0f", "name": "Complete End User Registration with Wallets", "request": { "name": "Complete End User Registration with Wallets", "description": { "content": "Completes the end user registration process and creates the user's initial credentials along with delegated wallets for the new end user.\n\nAll credentials submitted in this call (`firstFactorCredential`, `secondFactorCredential`, `recoveryCredential`) sign the same challenge returned by the registration init endpoint ([Create Delegated Registration Challenge](https://docs.dfns.co/api-reference/auth/create-delegated-registration-challenge) or [Create Social Registration Challenge](https://docs.dfns.co/api-reference/auth/create-social-registration-challenge)).\n\nAlways include a `recoveryCredential` for end users. Without one, a user who loses their device cannot recover access and you must initiate a delegated recovery manually. See [Implement end-user recovery](https://docs.dfns.co/guides/developers/end-user-recovery).\n\nThe type of credentials being registered is determined by the `credentialKind` field in the nested objects (`firstFactorCredential` , `secondFactorCredential` and `recoveryCredential`). Supported credential kinds are:\n* `Fido2`: User action is signed by a user's signing device using `WebAuthn`.\n* `Key`: User action is signed by a user's, or token's, private key.\n* `PasswordProtectedKey`: User action is signed by a user's, or token's, private key. The encrypted version of the private key is stored by Dfns and returns during the signing flow for the user to decrypt it.\n* `RecoveryKey`: Similar to `PasswordProtectedKey`, but this credential can only be used to recover an account, not to sign an action or login. Once this credential is used, all the other user's credentials are invalidated.\n\nThe number of delegated wallets created and the wallet types are determined by the `wallets` specifications. The end user is automatically assigned `ManagedDefaultEndUserAccess` managed permission that grants the end user full access to the wallets.", "type": "text/plain" }, "url": { "path": [ "auth", "registration", "enduser" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstFactorCredential\": {\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\"\n },\n \"wallets\": [\n {\n \"network\": \"CantonTestnet\",\n \"name\": \"string\"\n }\n ],\n \"secondFactorCredential\": {\n \"credentialKind\": \"Fido2\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"credentialName\": \"string\"\n },\n \"recoveryCredential\": {\n \"credentialKind\": \"RecoveryKey\",\n \"credentialInfo\": {\n \"credId\": \"string\",\n \"clientData\": \"string\",\n \"attestationData\": \"string\"\n },\n \"encryptedPrivateKey\": \"string\",\n \"credentialName\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c31b5ebf-5100-5548-8183-af265660846e", "name": "Resend Registration Code", "request": { "name": "Resend Registration Code", "description": { "content": "Sends the user a new registration code. The previous registration code will be marked invalid. If the user has already completed their registration no action will be taken.", "type": "text/plain" }, "url": { "path": [ "auth", "registration", "code" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"orgId\": \"or-30tnh-itmjs-s235s5ontr3r23h2\",\n \"tenantId\": \"acct-24hka-dhili-9hgvdlvr1ohpibp4\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "fce69293-f365-59ae-bc7e-eafc6da87fe8" }, { "name": "Service Accounts", "item": [ { "id": "344eb02b-98fc-5ff5-9df0-76598829f102", "name": "List Service Accounts", "request": { "name": "List Service Accounts", "description": { "content": "List all Service Accounts in your organization.", "type": "text/plain" }, "url": { "path": [ "auth", "service-accounts" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a1931ca-d75f-5326-960a-592a0b1e38a5", "name": "Create Service Account", "request": { "name": "Create Service Account", "description": { "content": "Create a new Service Account for your organization.", "type": "text/plain" }, "url": { "path": [ "auth", "service-accounts" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"publicKey\": \"-----BEGIN RSA PUBLIC KEY-----Sa0M-----END PUBLIC KEY-----\",\n \"permissionId\": \"pm-37vj4-jkr4l-lc9945spfftkne57\",\n \"externalId\": \"string\",\n \"daysValid\": 5699\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be5e15c4-2925-5588-ad3d-f0ea4c393c5f", "name": "Get Service Account", "request": { "name": "Get Service Account", "description": { "content": "Get information about a specific Service Account.", "type": "text/plain" }, "url": { "path": [ "auth", "service-accounts", ":serviceAccountId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "serviceAccountId", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b6111d2-1488-50a5-8c72-ece69dda1021", "name": "Update Service Account", "request": { "name": "Update Service Account", "description": { "content": "Update a specific Service Account.", "type": "text/plain" }, "url": { "path": [ "auth", "service-accounts", ":serviceAccountId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "serviceAccountId", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5c2a63c-e5e0-531e-9606-7235e023bb6c", "name": "Delete Service Account", "request": { "name": "Delete Service Account", "description": { "content": "Delete a specific Service Account.", "type": "text/plain" }, "url": { "path": [ "auth", "service-accounts", ":serviceAccountId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "If true, bypasses the policy approver check and deletes immediately.", "type": "text/plain" }, "key": "force", "value": "false" } ], "variable": [ { "type": "any", "value": "string", "key": "serviceAccountId", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2def5dfd-9eca-5ec3-bdbe-16a2dde98939", "name": "Activate Service Account", "request": { "name": "Activate Service Account", "description": { "content": "Activate a specific Service Account.", "type": "text/plain" }, "url": { "path": [ "auth", "service-accounts", ":serviceAccountId", "activate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "serviceAccountId", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3689f19b-de95-59fc-a72e-d26e755c9149", "name": "Deactivate Service Account", "request": { "name": "Deactivate Service Account", "description": { "content": "Deactivate a specific Service Account.", "type": "text/plain" }, "url": { "path": [ "auth", "service-accounts", ":serviceAccountId", "deactivate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "serviceAccountId", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"force\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "fac9a56d-50c7-5334-a584-99a1d9507434" }, { "name": "Users", "item": [ { "id": "41aff63c-7c02-5dc4-8d49-77ae9dcea6a3", "name": "Activate User", "request": { "name": "Activate User", "description": { "content": "Activate a specific User.", "type": "text/plain" }, "url": { "path": [ "auth", "users", ":userId", "activate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "userId", "disabled": false, "description": { "content": "(Required) User id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f616979a-5d70-5612-a829-f0869906e013", "name": "Deactivate User", "request": { "name": "Deactivate User", "description": { "content": "Deactivate a specific User.", "type": "text/plain" }, "url": { "path": [ "auth", "users", ":userId", "deactivate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "userId", "disabled": false, "description": { "content": "(Required) User id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "167d61e7-e0ed-5a22-9ce7-6b9ef8bbddb3", "name": "Delete User", "request": { "name": "Delete User", "description": { "content": "Delete a specific User.", "type": "text/plain" }, "url": { "path": [ "auth", "users", ":userId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "userId", "disabled": false, "description": { "content": "(Required) User id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13b8f5d8-f2cc-5603-818a-adb66577f5b6", "name": "Get User", "request": { "name": "Get User", "description": { "content": "Retrieve information about a specific User.", "type": "text/plain" }, "url": { "path": [ "auth", "users", ":userId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "userId", "disabled": false, "description": { "content": "(Required) User id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbf8e38a-add9-5d22-b4a2-8d4f49f4fe51", "name": "Update User", "request": { "name": "Update User", "description": { "content": "Update a specific User.", "type": "text/plain" }, "url": { "path": [ "auth", "users", ":userId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "userId", "disabled": false, "description": { "content": "(Required) User id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"isSSORequired\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8fb95bf-1304-5475-bd84-ec6919ba206e", "name": "Create User", "request": { "name": "Create User", "description": { "content": "Invite a new user in the caller's org. This will create the user and send a registration email to the created User's email, with a registration code, and pointing him to complete his registration on Dfns Dashboard. The user is created without any permissions.\n \n If you want the created User to not know about about Dfns, and don't want him to \n receive the registration email from Dfns, you should rather use the Delegated Registration \n endpoint.\n ", "type": "text/plain" }, "url": { "path": [ "auth", "users" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"zj-JIGgvgUx@XwCppJhCvMyWXcfUicFDQMYGfiGUW.ke\",\n \"kind\": \"CustomerEmployee\",\n \"publicKey\": \"string\",\n \"externalId\": \"string\",\n \"isSSORequired\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33ab7cfe-0722-5265-b39a-4ea01499c9b2", "name": "List Users", "request": { "name": "List Users", "description": { "content": "List all Users in your organization.", "type": "text/plain" }, "url": { "path": [ "auth", "users" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "16" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": true, "description": { "content": "Filter users by kind. (This can only be one of CustomerEmployee,EndUser)", "type": "text/plain" }, "key": "kind", "value": "EndUser" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a96e1493-7a6b-5cc3-8d09-2705fbc4aeb6", "name": "Invite Tenant User", "request": { "name": "Invite Tenant User", "description": { "content": "Invite an existing Tenant User in the caller's org. The invited Tenant User starts without any permissions within the org.", "type": "text/plain" }, "url": { "path": [ "auth", "users", "invite" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"k6N86Pnc9BL@GZAYsgzdzuOQIupAplhDGsaWSigloIR.etjp\",\n \"kind\": \"TenantUser\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "36034df0-787c-555c-a391-1b6ae6695032" }, { "id": "96dc6220-0852-55a1-b188-f5f812fb3219", "name": "Exchange Access Token", "request": { "name": "Exchange Access Token", "description": { "content": "Only for TenantUsers - Exchanges the current user access token, for an org-bound or tenant-bound token. The user must have access to the target org / tenant. The new access token expiration won't exceed the current token's one.", "type": "text/plain" }, "url": { "path": [ "auth", "tokens" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "915f8d7d-a691-5765-a051-787567d57bd5" }, { "name": "Exchanges", "description": "", "item": [ { "id": "c1c9ff89-baf0-569c-8b0a-5cec3e603049", "name": "Get Exchange", "request": { "name": "Get Exchange", "description": { "content": "Retrieve the details of a specific exchange integration configuration.", "type": "text/plain" }, "url": { "path": [ "exchanges", ":exchangeId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "exchangeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bafbdd80-ad5d-597d-a0f5-67761627ea52", "name": "Delete Exchange", "request": { "name": "Delete Exchange", "description": { "content": "Delete the exchange configuration from your organization.", "type": "text/plain" }, "url": { "path": [ "exchanges", ":exchangeId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "exchangeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c79ad4b2-9967-5aa1-8981-23f7bd51ffec", "name": "Create Exchange", "request": { "name": "Create Exchange", "description": { "content": "Link your organization with a cryptocurrency exchange.", "type": "text/plain" }, "url": { "path": [ "exchanges" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"CoinbaseApp\",\n \"readConfiguration\": {\n \"publicApiKey\": \"string\",\n \"privateApiKey\": \"string\",\n \"password\": \"string\",\n \"otp\": \"string\"\n },\n \"writeConfiguration\": {\n \"publicApiKey\": \"string\",\n \"privateApiKey\": \"string\",\n \"password\": \"string\",\n \"otp\": \"string\"\n },\n \"name\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96518c9b-3ce8-578b-b3d3-7ffa18bddb71", "name": "List Exchanges", "request": { "name": "List Exchanges", "description": { "content": "List all configured exchange integrations.", "type": "text/plain" }, "url": { "path": [ "exchanges" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "794bd0d0-1c87-5134-93a9-7831874b8c36", "name": "List Accounts", "request": { "name": "List Accounts", "description": { "content": "Get a list of accounts for a specific exchange.", "type": "text/plain" }, "url": { "path": [ "exchanges", ":exchangeId", "accounts" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "exchangeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8472b16-9ce5-5dc7-be30-abd96a0aed06", "name": "List Account Assets", "request": { "name": "List Account Assets", "description": { "content": "Retrieve the list of assets for a specific account on a specific exchange.", "type": "text/plain" }, "url": { "path": [ "exchanges", ":exchangeId", "accounts", ":accountId", "assets" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "exchangeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "accountId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a16af7ce-9547-531a-8efa-544d89fb4909", "name": "List Asset Withdrawal Networks", "request": { "name": "List Asset Withdrawal Networks", "description": {}, "url": { "path": [ "exchanges", ":exchangeId", "accounts", ":accountId", "assets", ":asset", "withdrawal-networks" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "exchangeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "accountId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "asset", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3288293b-5738-5dc0-bafe-24502c3db04c", "name": "Create Exchange Deposit", "request": { "name": "Create Exchange Deposit", "description": { "content": "Creates a new exchange deposit transaction.", "type": "text/plain" }, "url": { "path": [ "exchanges", ":exchangeId", "accounts", ":accountId", "deposits" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "exchangeId", "disabled": false, "description": { "content": "(Required) The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "accountId", "disabled": false, "description": { "content": "(Required) Unique identifier for the account like \"spot\"", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Native\",\n \"amount\": \"1\",\n \"walletId\": \"string\",\n \"priority\": \"Fast\",\n \"createDestinationAccount\": false,\n \"offer\": true,\n \"expiresAt\": \"1972-11-07T22:31:31.279Z\",\n \"useDurableNonce\": false,\n \"externalId\": \"string\",\n \"travelRule\": {\n \"kind\": \"Notabene\",\n \"originator\": {\n \"key_0\": 693.5599632561207\n },\n \"beneficiary\": {\n \"key_0\": 8772\n },\n \"beneficiaryVASPdid\": \"string\",\n \"beneficiaryProof\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n },\n \"feeSponsorId\": \"fs-5vqdl-gliqk-b4rfukqauov1sp7j\",\n \"otp\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91a66fbe-951e-5b23-808c-8c4253bf4acd", "name": "Create Exchange Withdrawal", "request": { "name": "Create Exchange Withdrawal", "description": { "content": "Creates a new exchange withdrawal transaction.", "type": "text/plain" }, "url": { "path": [ "exchanges", ":exchangeId", "accounts", ":accountId", "withdrawals" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "exchangeId", "disabled": false, "description": { "content": "(Required) The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "accountId", "disabled": false, "description": { "content": "(Required) Unique identifier for the account like \"spot\"", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Native\",\n \"amount\": \"1\",\n \"walletId\": \"string\",\n \"priority\": \"Fast\",\n \"createDestinationAccount\": false,\n \"offer\": true,\n \"expiresAt\": \"1972-11-07T22:31:31.279Z\",\n \"useDurableNonce\": false,\n \"externalId\": \"string\",\n \"travelRule\": {\n \"kind\": \"Notabene\",\n \"originator\": {\n \"key_0\": 693.5599632561207\n },\n \"beneficiary\": {\n \"key_0\": 8772\n },\n \"beneficiaryVASPdid\": \"string\",\n \"beneficiaryProof\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n },\n \"feeSponsorId\": \"fs-5vqdl-gliqk-b4rfukqauov1sp7j\",\n \"otp\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "6f8645df-46b7-5110-bf57-0cb86338b9b6" }, { "name": "Fee Sponsors", "description": "", "item": [ { "id": "2c5427e7-4223-554c-b25d-8793d11e8932", "name": "Create Fee Sponsor", "request": { "name": "Create Fee Sponsor", "description": { "content": "Creates a new `FeeSponsor` associated with a sponsor wallet. Returns a new fee sponsor entity with the `id` to be used when making a transfer.", "type": "text/plain" }, "url": { "path": [ "fee-sponsors" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"wa-5pfuu-9euek-h0odgb6snva8ph3k\",\n \"name\": \"string\",\n \"allowEndUser\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65157d01-4b0a-5709-a050-fd5a7d7e7e3f", "name": "List Fee Sponsors", "request": { "name": "List Fee Sponsors", "description": { "content": "Retrieves all Fee Sponsors configured in your organization.", "type": "text/plain" }, "url": { "path": [ "fee-sponsors" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9017c37-c587-5fe1-b18e-a21d1c074642", "name": "Get Fee Sponsor", "request": { "name": "Get Fee Sponsor", "description": { "content": "Retrieve a Fee Sponsor information by ID.", "type": "text/plain" }, "url": { "path": [ "fee-sponsors", ":feeSponsorId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "fs-7jlps-mdrtm-pok6ws6gfkogkt", "key": "feeSponsorId", "disabled": false, "description": { "content": "(Required) Which Fee Sponsor you wish to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3e55c8b-01a8-515a-92ff-927d74b3c45b", "name": "Delete Fee Sponsor", "request": { "name": "Delete Fee Sponsor", "description": { "content": "Delete a Fee Sponsor. This action is irreversible. The fee sponsor won't be able to be used anymore when making a transfer.", "type": "text/plain" }, "url": { "path": [ "fee-sponsors", ":feeSponsorId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "fs-ss2hz-a0tyi-nueje6bbdahkn5dm", "key": "feeSponsorId", "disabled": false, "description": { "content": "(Required) Which Fee Sponsor you wish to delete.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf683090-6efd-5ebf-8f27-bbf58c3ed80a", "name": "Deactivate Fee Sponsor", "request": { "name": "Deactivate Fee Sponsor", "description": { "content": "Deactivate a Fee Sponsor: The fee sponsor won't be able to be used anymore when making a transfer.", "type": "text/plain" }, "url": { "path": [ "fee-sponsors", ":feeSponsorId", "deactivate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "fs-mmqb1-latf0-18i1p8f0xca5t6", "key": "feeSponsorId", "disabled": false, "description": { "content": "(Required) Which Fee Sponsor you wish to deactivate.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a243299-9eae-5a96-b518-5201418e4bbc", "name": "Activate Fee Sponsor", "request": { "name": "Activate Fee Sponsor", "description": { "content": "Activate a Fee Sponsor: The fee sponsor can be used when making a transfer.", "type": "text/plain" }, "url": { "path": [ "fee-sponsors", ":feeSponsorId", "activate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "fs-m8csd-zy4dm-m28rqn1c9tsr4h09", "key": "feeSponsorId", "disabled": false, "description": { "content": "(Required) Which Fee Sponsor you wish to activate.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77bcc35a-30f2-5a21-b489-79c6b5b7567e", "name": "List Sponsored Fees", "request": { "name": "List Sponsored Fees", "description": { "content": "Retrieves all fees paid by the specific Fee Sponsor.", "type": "text/plain" }, "url": { "path": [ "fee-sponsors", ":feeSponsorId", "fees" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "55460779" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "fs-6c95s-vumtu-3yso0uyzkh267xw", "key": "feeSponsorId", "disabled": false, "description": { "content": "(Required) Fee Sponsor to retrieve the fees from.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "18352aa4-3568-50e4-ab64-6d8fb18ba8a8" }, { "name": "Keys", "description": "", "item": [ { "name": "Signatures", "item": [ { "id": "c4811146-39b4-535b-a099-09cfbe026170", "name": "Generate Signature", "request": { "name": "Generate Signature", "description": { "content": "Request to generate a signature with the key. **This process does not broadcast anything on-chain**, this is just an off-chain signature request.\n\nDfns is compatible with any blockchain that uses a supported [key format](https://docs.dfns.co/networks/supported-key-formats). If Dfns doesn't officially integrate with a blockchain, you can use hash signing to generate the signatures to interact with the chain.\n\n\nIf you were using the deprecated `POST /wallets/{walletId}/signatures` endpoint, then you should now use this one. See the [deprecation notice](https://docs.dfns.co/developers/guides/keys-and-multichain-migration-guide) to get more information about how to change your code. TL,DR: from a wallet you can obtain the key as `wallet.signingKey.id`.\n\n", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId", "signatures" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) The key to sign with.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"network\": \"BitcoinSignet\",\n \"kind\": \"Bip322\",\n \"message\": \"0x49206c6f76652044666e73\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f782a28-69ff-5604-9d1d-46b6c357ea5a", "name": "List Signatures", "request": { "name": "List Signatures", "description": { "content": "List all signature requests for a key.", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId", "signatures" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) The key to list signatures for.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f185fb9-0d78-5e66-adbc-617ea93c1824", "name": "Get Signature", "request": { "name": "Get Signature", "description": { "content": "Retrieve a signature request details.", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId", "signatures", ":signatureId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) The key that was used for signing.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "signatureId", "disabled": false, "description": { "content": "(Required) The signature request to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "b680c3fc-fd2b-52b8-8917-bfda92ed2689" }, { "id": "f32a850e-f05b-52c4-9698-ee0c3298bf07", "name": "Create Key", "request": { "name": "Create Key", "description": { "content": "Creates a key for the given scheme and curve. Returns the new key entity. ", "type": "text/plain" }, "url": { "path": [ "keys" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheme\": \"EdDSA\",\n \"curve\": \"ed25519\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0418a7d9-9db2-5286-8c1a-09cfae0ec571", "name": "List Keys", "request": { "name": "List Keys", "description": { "content": "Retrieve all keys registered for your organization.", "type": "text/plain" }, "url": { "path": [ "keys" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": true, "description": { "content": "Filter by owner id or username.", "type": "text/plain" }, "key": "owner", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1eca0879-7e2e-55a6-a09d-9ae234192558", "name": "Delegate Key", "request": { "name": "Delegate Key", "description": { "content": "\nOnly keys created with \"`delayDelegation: true`\" can then be delegated to an end-user. It means you need to know ahead of time that you're creating a wallet meant to be delegated to an end-user later. This is a safety to prevent, for example, a treasury wallet from being unintentionally delegated to an end-user.\n\n\n\nWhen a key is delegated to an end user, all wallets using this key as the signing key are also automatically delegated to the same end user. Key and wallet ownerships are guaranteed to be always consistent.\n\n\n\nThis operation is irreversible. The key ownership will be transferred to the end-user\n\n\nIn most cases, when you want to implement [Wallet Delegation](https://docs.dfns.co/developers/guides/wallet-delegation), simply create the wallet by directly delegating it to an end user, in which case it will the non-custodial from the start. There are some rare cases, however, where the key or wallet must be created before the user has accessed to the system. To accommodate this, we've added the ability to create a key or wallet in delay delegation mode, and then later delegate it (i.e.: transfer ownership of it) to an end user via this endpoint.\n", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId", "delegate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"delegateTo\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13387efb-c549-5902-af3c-92c6a3ceaeca", "name": "Delete Key", "request": { "name": "Delete Key", "description": { "content": "Deletes the key and all wallets using this key. Once deleted, keys (and wallets) are not usable anymore, and won't count in your overall organisation wallet count.", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a869550-a1d1-58e8-a4cc-1f29b72566d7", "name": "Get Key", "request": { "name": "Get Key", "description": { "content": "Retrieves a key information by its ID.", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) The key to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2749f1f5-d07a-5b41-b314-8a5b621b345f", "name": "Update Key", "request": { "name": "Update Key", "description": { "content": "Updates the name of an existing key.", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a05829b-f989-5c8e-8bfa-f3f2ff66e306", "name": "Derive Key", "request": { "name": "Derive Key", "description": { "content": "Dfns decentralized key management network supports threshold Diffie-Hellman protocol based on [GLOW20 paper](https://eprint.iacr.org/2020/096). You can use the DH protocol to derive output from a domain separation tag and a seed value. The derivation process is deterministic, i.e. the same Diffie-Hellman key and seed will lead to the same derived output. To ensure reproducibility, we use hash to curve [RFC9380](https://www.rfc-editor.org/rfc/rfc9380.html) and standard ciphersuite `secp256k1_XMD:SHA-256_SSWU_RO_`.\n\n\nThe seed doesn’t need to be secret. Without access to the DH key, it is not possible to do the derivation, even if the seed is known. Moreover, if both seed and derived output are known, it’s also not possible to do the derivation for another seed without having access to the DH key.\n\n\nThis endpoint only supports Diffie-Hellman keys. Regular threshold signature keys, like `ECDSA` or `EdDSA`, will not work. You can create a Diffie-Hellman key with the [Create Key](https://docs.dfns.co/api-reference/keys/create-key) endpoint using `scheme=DH` and `curve=secp256k1`.", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId", "derive" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"1CFdACEbF2\",\n \"seed\": \"0x7f5Cd2FB\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a7a2747-1214-54a0-81a2-6dd98ac581f0", "name": "Export Key", "request": { "name": "Export Key", "description": { "content": "Dfns secures private keys by generating them as MPC key shares in our decentralized key management network. Our goal is to eliminate all single points of failure (SPOFs) associated with blockchain private keys.\n\nIn certain circumstances, however, customers require Dfns to export a private key. In this case, Dfns exposes the following endpoint which can be used in conjunction with our [export SDK](https://github.com/dfns/dfns-sdk-ts/tree/m/examples/sdk/export-wallet).\n\n\nDfns can not guarantee the security of exported keys as we have no way to control blockchain transactions once the single point of failure has been reconstituted. For this reason, this feature is restricted to customers who have signed a contractual addendum limiting our liability for exported keys. Additionally, by default exported keys can no longer be used to sign within the Dfns platform. Please contact your sales representative for more information.\n", "type": "text/plain" }, "url": { "path": [ "keys", ":keyId", "export" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "keyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"encryptionKey\": \"string\",\n \"supportedSchemes\": [\n {\n \"protocol\": \"FROST_BITCOIN\",\n \"curve\": \"stark\"\n },\n {\n \"protocol\": \"GLOW20_DH\",\n \"curve\": \"stark\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3dc4979-cd1f-5ff4-a16a-ea00a002a5d6", "name": "Import Key", "request": { "name": "Import Key", "description": { "content": "Dfns secures private keys by generating them as MPC key shares in our decentralized key management network. This happens by default when you create a [key](https://docs.dfns.co/api-reference/keys/create-key) or [wallet](https://docs.dfns.co/api-reference/wallets/create-wallet).\n\nIn some circumstances, however, you may need to import an existing private key into Dfns infrastructure, instead of creating a brand new wallet with Dfns and transfer funds to it. As an example, you might want to keep an existing wallet if its address is tied to a smart contract which you don't want to re-deploy.\n\nIn such a case, Dfns exposes this key import API endpoint, which can be used in conjunction with our [import SDK](https://github.com/dfns/dfns-sdk-ts/tree/m/examples/sdk/import-wallet). Note this is intended to be used only to migrate wallets when first onboarding onto the Dfns platform.\n\n\nDfns can not guarantee the security of imported wallets, as we have no way to control who had access to the private key prior to import. For this reason, this feature is restricted to Enterprise customers who have signed a contractual addendum limiting our liability for imported keys. Please contact your sales representative for more information.\n\n", "type": "text/plain" }, "url": { "path": [ "keys", "import" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"curve\": \"secp256k1\",\n \"protocol\": \"FROST_BITCOIN\",\n \"minSigners\": 5562,\n \"encryptedKeyShares\": [\n {\n \"signerId\": \"string\",\n \"encryptedKeyShare\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"masterKey\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "e093a4b3-2447-5ec4-ba3a-cf911c4a0741" }, { "name": "Networks", "description": "", "item": [ { "name": "Canton Validators", "item": [ { "id": "2d85221e-3afc-5e4a-824b-f186d83db4ba", "name": "Call Function", "request": { "name": "Call Function", "description": { "content": "Call a read-only function on a smart contract. In Solidity, these are functions with the state mutability set to `view`.\n\n \n Currently only works on EVM compatible chains.\n ", "type": "text/plain" }, "url": { "path": [ "networks", ":network", "call-function" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "network", "disabled": false, "description": { "content": "(Required) Network name formatted in kebab case", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"0xc53D9b9acb1aec1BbF69A9F894beFBD2478dA642\",\n \"abi\": {\n \"type\": \"string\",\n \"name\": \"string\",\n \"stateMutability\": \"string\",\n \"inputs\": [\n {\n \"name\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"outputs\": [\n {\n \"name\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"type\": \"string\"\n }\n ]\n },\n \"calldata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65b7e98c-ac88-5248-b20e-7be0084eba9d", "name": "Get Canton Validator", "request": { "name": "Get Canton Validator", "description": { "content": "Return a configured Canton Validator in your organization.", "type": "text/plain" }, "url": { "path": [ "networks", ":network", "validators", ":validatorId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "canton-devnet", "key": "network", "disabled": false, "description": { "content": "(Required) (This can only be one of canton,canton-devnet,canton-testnet)", "type": "text/plain" } }, { "type": "any", "value": "cv-fr3rl-b7uvn-5mwiq6h7kuqt2vg", "key": "validatorId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97942e2e-ba03-5af3-b840-5aee8182e1ff", "name": "Update Canton Validator", "request": { "name": "Update Canton Validator", "description": { "content": "Update an existing Canton Validator configuration.\n \n Read details about the process [here](https://docs.dfns.co/networks/canton-validators). ", "type": "text/plain" }, "url": { "path": [ "networks", ":network", "validators", ":validatorId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "canton-devnet", "key": "network", "disabled": false, "description": { "content": "(Required) (This can only be one of canton,canton-devnet,canton-testnet)", "type": "text/plain" } }, { "type": "any", "value": "cv-fr3rl-b7uvn-5mwiq6h7kuqt2vg", "key": "validatorId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"validator\": {\n \"url\": \"http://UekVbrQLwSynjePWigRFGovtYpqsFh.gighbj+l6dKvqKl,+BhRSL51kPKEFCQBlwrKXf2O92F5MCNRAGUaQv2yVVhFdPPy,B3GxQZgQEZNN\",\n \"oauth2\": {\n \"domain\": \"http://qNKjy.mmTG2r+V\",\n \"audience\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"tokenPath\": \"string\"\n }\n },\n \"ledger\": {\n \"url\": \"http://mfdPloctDmETfUnBcPIegKDnHkGMi.aryw6rtl2NJqEb2J4L5TkoBe,rI\",\n \"oauth2\": {\n \"domain\": \"http://bVXcVjKPNvrRlXudCfPpAQ.tkirXzIARTxylsQfpZbvt,KI9Zc4pzEabFZF8EpV0UxA6.bL+RFPKJvT\",\n \"audience\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"tokenPath\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e626831-7ee3-5510-b0c5-4a878eb748e2", "name": "Delete Canton Validator", "request": { "name": "Delete Canton Validator", "description": { "content": "Delete a specific Canton Validator configuration.", "type": "text/plain" }, "url": { "path": [ "networks", ":network", "validators", ":validatorId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "canton-devnet", "key": "network", "disabled": false, "description": { "content": "(Required) (This can only be one of canton,canton-devnet,canton-testnet)", "type": "text/plain" } }, { "type": "any", "value": "cv-fr3rl-b7uvn-5mwiq6h7kuqt2vg", "key": "validatorId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "debb69bf-943a-5e9f-a659-42baa33703a0", "name": "Create Canton Validator", "request": { "name": "Create Canton Validator", "description": { "content": "Link a Canton Validator to your organization. This is required in order to create wallets or interact with the Canton network.\n\n The `Shared` option allows you to use a shared validator hosted by Dfns and get started in seconds, while the `Custom` option allows you to connect your own validator and ledger nodes using OAuth2 authentication.\n\n Read details about the process [here](https://docs.dfns.co/networks/canton-validators). ", "type": "text/plain" }, "url": { "path": [ "networks", ":network", "validators" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "canton-devnet", "key": "network", "disabled": false, "description": { "content": "(Required) (This can only be one of canton,canton-devnet,canton-testnet)", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Shared\",\n \"name\": \"My shared validator\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "231d4417-84f3-57dc-b8cf-188ef8fc6c9a", "name": "List Canton Validators", "request": { "name": "List Canton Validators", "description": { "content": "Retrieve the list of configured Canton Validators in your organization.", "type": "text/plain" }, "url": { "path": [ "networks", ":network", "validators" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "canton-devnet", "key": "network", "disabled": false, "description": { "content": "(Required) (This can only be one of canton,canton-devnet,canton-testnet)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "3c7e9565-c311-5cd8-937a-76dae99be957" }, { "id": "1d4ee1eb-7b9c-5816-b66f-35db1e5ce62f", "name": "Estimate Fees", "request": { "name": "Estimate Fees", "description": { "content": "Gets real-time fee details for a given network, allowing users to make decisions based on their preferences for transaction speed/priority. Three levels of priority will be displayed: `slow`, `standard`, `fast`.", "type": "text/plain" }, "url": { "path": [ "networks", "fees" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of Bitcoin,BitcoinSignet,BitcoinTestnet4,Litecoin,LitecoinTestnet,Dogecoin,DogecoinTestnet,ArbitrumOne,ArbitrumSepolia,ArcTestnet,AvalancheC,AvalancheCFuji,Base,BaseSepolia,Bob,BobSepolia,Bsc,BscTestnet,Berachain,BerachainBepolia,Celo,CeloAlfajores,Codex,CodexSepolia,Ethereum,EthereumClassic,EthereumClassicMordor,EthereumSepolia,EthereumHoodi,FlareC,FlareCCoston2,FlowEvm,FlowEvmTestnet,Ink,InkSepolia,Optimism,OptimismSepolia,Plasma,PlasmaTestnet,Plume,PlumeSepolia,Polygon,PolygonAmoy,Race,RaceSepolia,Robinhood,RobinhoodSepolia,Sonic,SonicTestnet,Tempo,TempoModerato,Tsc,TscTestnet1,Xdc,XdcApothem,XLayer,XLayerSepolia,Solana,SolanaDevnet)", "type": "text/plain" }, "key": "network", "value": "Race" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "df22b2c6-35ad-57f0-8059-355aaa5866b1" }, { "name": "Payouts", "description": "", "item": [ { "id": "079cc5db-c9e2-5aab-875c-b9630df32534", "name": "Create Payout", "request": { "name": "Create Payout", "description": { "content": "\n Create a new payout to convert crypto assets to fiat currency.\n ", "type": "text/plain" }, "url": { "path": [ "payouts" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"wa-5pfuu-9euek-h0odgb6snva8ph3k\",\n \"asset\": {\n \"kind\": \"Erc20\",\n \"amount\": \"447\",\n \"contract\": \"string\"\n },\n \"fiatCurrency\": \"WHC\",\n \"provider\": \"Borderless\",\n \"country\": \"LD\",\n \"borderlessAccountId\": \"string\",\n \"paymentInstructionsId\": \"string\",\n \"paymentPurpose\": \"advertising expenses\",\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2dd2bc2-42f5-5115-810c-07c1dbb8d4f6", "name": "List Payouts", "request": { "name": "List Payouts", "description": { "content": "List payouts with optional filtering and pagination.", "type": "text/plain" }, "url": { "path": [ "payouts" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "4" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": true, "description": { "content": "Filter payouts by wallet ID.", "type": "text/plain" }, "key": "walletId", "value": "string" }, { "disabled": true, "description": { "content": "Filter payouts by status (comma-separated).", "type": "text/plain" }, "key": "status", "value": "Expired" }, { "disabled": true, "description": { "content": "Filter payouts by status (comma-separated).", "type": "text/plain" }, "key": "status", "value": "Processing" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78d1e69c-bef1-5abe-b1a4-171f8aad48d3", "name": "Request Payout Quote", "request": { "name": "Request Payout Quote", "description": { "content": "Request a quote from a given provider for a payout. Returns estimated fiat amount and fees.", "type": "text/plain" }, "url": { "path": [ "payouts", "quote" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"wa-5pfuu-9euek-h0odgb6snva8ph3k\",\n \"asset\": {\n \"kind\": \"Erc20\",\n \"amount\": \"30577329329\",\n \"contract\": \"string\"\n },\n \"fiatCurrency\": \"ITI\",\n \"provider\": \"Borderless\",\n \"country\": \"RE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a39a653-eff9-559e-9c15-b97cda50bf48", "name": "Get Payout Status", "request": { "name": "Get Payout Status", "description": { "content": "\n Retrieve the current status of a payout by its ID.\n ", "type": "text/plain" }, "url": { "path": [ "payouts", ":payoutId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "payoutId", "disabled": false, "description": { "content": "(Required) Payout id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3fde6743-c654-5d92-bac6-05dc527700d5", "name": "Create Payout Action", "request": { "name": "Create Payout Action", "description": { "content": "\n Perform an action on a payout, such as confirming or canceling.\n ", "type": "text/plain" }, "url": { "path": [ "payouts", ":payoutId", "action" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "payoutId", "disabled": false, "description": { "content": "(Required) Payout id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"Confirm\",\n \"walletId\": \"wa-5pfuu-9euek-h0odgb6snva8ph3k\",\n \"transfer\": {\n \"kind\": \"Erc20\",\n \"amount\": \"442553851\",\n \"contract\": \"string\",\n \"to\": \"0xa4aC74b4B91Cf7BC88D7AA8eB6f9CD0A3e84a4C4\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "9c9e7839-2321-58cc-8812-ef41d7442171" }, { "name": "Permissions", "description": "", "item": [ { "id": "49475274-a09e-582e-9515-2b6f2a2e288d", "name": "Archive Permission", "request": { "name": "Archive Permission", "description": { "content": "Archives or unarchives a permission (role). Archived permissions are effectively soft-deleted.", "type": "text/plain" }, "url": { "path": [ "permissions", ":permissionId", "archive" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "permissionId", "disabled": false, "description": { "content": "(Required) ID of the permission (also referred to as \"role\" in the dashboard).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"isArchived\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8ef9d33-061d-5920-b2d6-9b60ff4f5778", "name": "Assign Permission", "request": { "name": "Assign Permission", "description": { "content": "Assigns a permission (role) to an identity (user, PAT or service account), granting it access to the operations defined in the permission. Returns the assignment on success (200), or a pending change request if approval is required (202).", "type": "text/plain" }, "url": { "path": [ "permissions", ":permissionId", "assignments" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "permissionId", "disabled": false, "description": { "content": "(Required) ID of the permission (also referred to as \"role\" in the dashboard).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identityId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ae773d2-5cd7-5587-99f8-51a4ab5a2298", "name": "List Permission Assignments", "request": { "name": "List Permission Assignments", "description": { "content": "Lists all permission (role) assignments for a given permission.", "type": "text/plain" }, "url": { "path": [ "permissions", ":permissionId", "assignments" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "permissionId", "disabled": false, "description": { "content": "(Required) ID of the permission (also referred to as \"role\" in the dashboard).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ae20844-8ba6-51ad-81aa-52a8943d18ee", "name": "Create Permission", "request": { "name": "Create Permission", "description": { "content": "Creates a new permission (also referred to as \"role\" in the dashboard) that grants access to the specified API operations.", "type": "text/plain" }, "url": { "path": [ "permissions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"operations\": [\n \"Auth:ServiceAccounts:Read\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78e246f1-163c-50eb-9937-5f7fffab317c", "name": "List Permissions", "request": { "name": "List Permissions", "description": { "content": "Lists all permissions (roles) in the organization.", "type": "text/plain" }, "url": { "path": [ "permissions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f8af670-8abf-5d18-910c-c5f19a86721c", "name": "Revoke Permission", "request": { "name": "Revoke Permission", "description": { "content": "Revokes a permission (role) assignment, removing the identity's access to the operations granted by the permission.", "type": "text/plain" }, "url": { "path": [ "permissions", ":permissionId", "assignments", ":assignmentId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "If true, bypasses the approval process and revokes immediately.", "type": "text/plain" }, "key": "force", "value": "false" } ], "variable": [ { "type": "any", "value": "string", "key": "permissionId", "disabled": false, "description": { "content": "(Required) ID of the permission (also referred to as \"role\" in the dashboard).", "type": "text/plain" } }, { "type": "any", "value": "as-67evg-qsptw-sp510o15mf1j1qd", "key": "assignmentId", "disabled": false, "description": { "content": "(Required) ID of the permission assignment.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "753085f5-489f-5083-a1bf-3f8d20547aa4", "name": "Get Permission", "request": { "name": "Get Permission", "description": { "content": "Retrieves a permission (role) by ID, including any pending change request.", "type": "text/plain" }, "url": { "path": [ "permissions", ":permissionId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "permissionId", "disabled": false, "description": { "content": "(Required) ID of the permission (also referred to as \"role\" in the dashboard).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "920be1df-0a9d-5aec-9904-db779cd9ed63", "name": "Update Permission", "request": { "name": "Update Permission", "description": { "content": "Updates the name or operations of an existing permission (role).", "type": "text/plain" }, "url": { "path": [ "permissions", ":permissionId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "permissionId", "disabled": false, "description": { "content": "(Required) ID of the permission (also referred to as \"role\" in the dashboard).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"operations\": [\n \"Permissions:Assignments:Read\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "bc313689-63bb-5726-9009-2146d9cbfafe" }, { "name": "Policies", "description": "", "item": [ { "name": "Approval", "item": [ { "id": "8a4c6ea0-398d-5a7f-a9c1-ee676ae96268", "name": "Create Approval Decision", "request": { "name": "Create Approval Decision", "description": { "content": "Approve or Reject an Approval request.", "type": "text/plain" }, "url": { "path": [ "v2", "policy-approvals", ":approvalId", "decisions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "approvalId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"Denied\",\n \"reason\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fca744d8-6482-5018-a902-9d79bcbf487b", "name": "Get Approval", "request": { "name": "Get Approval", "description": { "content": "Retrieve information about a specific approval request.", "type": "text/plain" }, "url": { "path": [ "v2", "policy-approvals", ":approvalId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "approvalId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae49367c-db38-5597-a683-829a54a8de6b", "name": "List Approvals", "request": { "name": "List Approvals", "description": { "content": "Retrieve the list of pending approval requests.", "type": "text/plain" }, "url": { "path": [ "v2", "policy-approvals" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "55460779" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": true, "description": { "content": " (This can only be one of Pending,Approved,Denied,Expired)", "type": "text/plain" }, "key": "status", "value": "Expired" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "initiatorId", "value": "string" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "approverId", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "9222fce2-5419-5e56-9bc9-9c762990d518" }, { "id": "3661b033-aeae-5143-8127-fd63a9e49dcb", "name": "Delete Policy", "request": { "name": "Delete Policy", "description": { "content": "Delete an existing policy.", "type": "text/plain" }, "url": { "path": [ "v2", "policies", ":policyId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "policyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f753179-fba6-58f4-bb0f-161ce3e18686", "name": "Get Policy", "request": { "name": "Get Policy", "description": { "content": "Retrieve information about a specific policy.", "type": "text/plain" }, "url": { "path": [ "v2", "policies", ":policyId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "policyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d351a92c-b6f7-5763-8609-c518ecb10e42", "name": "Update Policy", "request": { "name": "Update Policy", "description": { "content": "Update an existing policy.", "type": "text/plain" }, "url": { "path": [ "v2", "policies", ":policyId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "policyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"activityKind\": \"Registry:Addresses:Modify\",\n \"rule\": {\n \"kind\": \"AlwaysTrigger\",\n \"configuration\": {}\n },\n \"action\": {\n \"kind\": \"RequestApproval\",\n \"approvalGroups\": [\n {\n \"quorum\": 3579,\n \"approvers\": {\n \"userId\": {\n \"in\": [\n \"string\"\n ]\n }\n },\n \"name\": \"string\",\n \"initiatorCanApprove\": true,\n \"serviceAccountsCanApprove\": true\n }\n ],\n \"autoRejectTimeout\": null\n },\n \"filters\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84fed347-5bed-5c3d-92e1-42b6fde01915", "name": "Create Policy", "request": { "name": "Create Policy", "description": { "content": "Setup a new Policy for your organization.\n \n Every policy requires a rule to be specified. Upon policy evaluation, the configuration specified in the rule will be used to determine whether the policy should trigger or not for a given activity.\n \n By exposing controls on permissions and policies, Dfns enables the specification of an admin quorum to approve sensitive actions which could change system governance. Note Dfns does not expose a separate \"admin quorum\" concept like some of our competitors - we simply enable this use case as another configuration of the policy engine itself. This was chosen to promote flexibility as not every customer will have the same requirements around creating and managing admin quorums.", "type": "text/plain" }, "url": { "path": [ "v2", "policies" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"chainalysis prescreening policy\",\n \"activityKind\": \"Wallets:Sign\",\n \"rule\": {\n \"kind\": \"ChainalysisTransactionPrescreening\",\n \"configuration\": {\n \"alerts\": {\n \"alertLevel\": \"LOW\",\n \"categoryIds\": []\n },\n \"exposures\": {\n \"direct\": {\n \"categoryIds\": []\n }\n },\n \"addresses\": {\n \"alertLevel\": \"LOW\",\n \"categoryIds\": []\n },\n \"fallbackBehaviours\": {\n \"skipUnscreenableTransaction\": false,\n \"skipUnsupportedNetwork\": false,\n \"skipUnsupportedAsset\": false,\n \"skipChainalysisFailure\": false\n }\n }\n },\n \"action\": {\n \"kind\": \"Block\"\n },\n \"filters\": {\n \"walletId\": {\n \"in\": [\n \"wa-4sql3-a6ct4-8j2q8ih86d853rgg\",\n \"wa-j9btt-5s9o8-i3r8373ddg0usn3\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "415062e9-76ae-5586-9dbc-b92f0a6690c0", "name": "List Policies", "request": { "name": "List Policies", "description": { "content": "Retrieve the list of policies on your organization.", "type": "text/plain" }, "url": { "path": [ "v2", "policies" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "55460779" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": true, "description": { "content": " (This can only be one of Active,Archived)", "type": "text/plain" }, "key": "status", "value": "Active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "871185c9-d1f0-5c8f-8414-f28445c66259" }, { "name": "Signers", "description": "", "item": [ { "id": "fd2aed9c-a80c-5d7b-854e-94fe8d73df2f", "name": "Create Add Mac User Input", "request": { "name": "Create Add Mac User Input", "description": {}, "url": { "path": [ "key-stores", ":storeId", "add-mac-user", "input" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/zip" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"AddMacUser\",\n \"macTargetSerial\": \"string\",\n \"hsmTargetSerial\": \"str\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b0d1c03-b094-54a1-a9f3-1f0823a138aa", "name": "Create Clone Input", "request": { "name": "Create Clone Input", "description": {}, "url": { "path": [ "key-stores", ":storeId", "clone", "input" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/zip" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Clone\",\n \"hsmSourceSerial\": \"string\",\n \"hsmTargetSerial\": \"string\",\n \"macTargetSerial\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e9c092f-06ef-5513-8903-e185820da418", "name": "Create Genesis Input", "request": { "name": "Create Genesis Input", "description": {}, "url": { "path": [ "key-stores", ":storeId", "genesis", "input" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/zip" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Genesis\",\n \"numProvisioners\": 3,\n \"numSecp256k1\": 1877,\n \"numEd25519\": 697,\n \"hsmGenesisSerial\": \"string\",\n \"macGenesisSerial\": \"string\",\n \"hsmGenesisFirmwareVersion\": \"2.2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "651ccbe2-2697-55bd-8dea-21bc4372feba", "name": "Create Onchain Sign Input", "request": { "name": "Create Onchain Sign Input", "description": {}, "url": { "path": [ "key-stores", ":storeId", "onchain-sign", "input" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/zip" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd66b98a-408c-5ecc-ad2f-ed7d0db21905", "name": "Create Proof Of Control Input", "request": { "name": "Create Proof Of Control Input", "description": {}, "url": { "path": [ "key-stores", ":storeId", "proof-of-control", "input" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/zip" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f973fc1-b181-5ca3-864d-96d4a7fd108c", "name": "List Key Stores", "request": { "name": "List Key Stores", "description": {}, "url": { "path": [ "key-stores" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d8eb35f-6c50-5d2b-b50c-7397571fd1b1", "name": "List Signers", "request": { "name": "List Signers", "description": {}, "url": { "path": [ "signers" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea88af3d-12a5-5a3c-879b-3ea36c071c50", "name": "Submit Add Mac User Output", "request": { "name": "Submit Add Mac User Output", "description": {}, "url": { "path": [ "key-stores", ":storeId", "add-mac-user", "output" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "data", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6cf784e-bdc9-52d4-a3dd-898fcb9d22ff", "name": "Submit Clone Output", "request": { "name": "Submit Clone Output", "description": {}, "url": { "path": [ "key-stores", ":storeId", "clone", "output" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "data", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab5101d1-a58c-5a07-9721-cd31c208cded", "name": "Submit Genesis Output", "request": { "name": "Submit Genesis Output", "description": {}, "url": { "path": [ "key-stores", ":storeId", "genesis", "output" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "data", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b10ad684-8901-5823-a530-36a134667f45", "name": "Submit Onchain Sign Output", "request": { "name": "Submit Onchain Sign Output", "description": {}, "url": { "path": [ "key-stores", ":storeId", "onchain-sign", "output" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "data", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2aa23f3b-3ae6-5784-9521-fb35619d955c", "name": "Submit Proof Of Control Output", "request": { "name": "Submit Proof Of Control Output", "description": {}, "url": { "path": [ "key-stores", ":storeId", "proof-of-control", "output" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "data", "value": "[object Object]", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "e2388fec-c83c-5bbe-8e39-5114df214999" }, { "name": "Staking", "description": "", "item": [ { "id": "3993382b-aaa6-55ee-ad9e-15167cad6377", "name": "Create Stake", "request": { "name": "Create Stake", "description": { "content": "Create a new stake.", "type": "text/plain" }, "url": { "path": [ "staking", "stakes" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"ext-123\",\n \"walletId\": \"wa-4g991-s29to-9hrq4nbuto6ih33b\",\n \"protocol\": \"Ethereum\",\n \"provider\": \"Figment\",\n \"amount\": \"32000000000000000000\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49ef232a-7337-5fbc-879b-6665e984bd97", "name": "List Stakes", "request": { "name": "List Stakes", "description": { "content": "Retrieve the list of stakes.", "type": "text/plain" }, "url": { "path": [ "staking", "stakes" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aab95a49-4f74-591f-b2b7-efb06c36fc5f", "name": "Create Stake Action", "request": { "name": "Create Stake Action", "description": { "content": "Create a new action for an existing stake.", "type": "text/plain" }, "url": { "path": [ "staking", "stakes", ":stakeId", "actions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "stk-qx569-ti9h5-epu8z1bumqmr26", "key": "stakeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"protocol\": \"Iota\",\n \"kind\": \"Withdraw\",\n \"amount\": \"463037\",\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a380ad83-90ea-5048-b02f-6b63351ed422", "name": "List Stake Actions", "request": { "name": "List Stake Actions", "description": { "content": "Retrieve the list of actions for a specific stake.", "type": "text/plain" }, "url": { "path": [ "staking", "stakes", ":stakeId", "actions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "stk-qx569-ti9h5-epu8z1bumqmr26", "key": "stakeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fd7e9d6-b88d-53ab-9274-6efd304f24d2", "name": "Get Stakes", "request": { "name": "Get Stakes", "description": { "content": "Retrieve the details of a specific stake.", "type": "text/plain" }, "url": { "path": [ "staking", "stakes", ":stakeId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "stk-qx569-ti9h5-epu8z1bumqmr26", "key": "stakeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7dc1aa23-307f-55b9-b6ac-288cdc634b90", "name": "Get Stake Rewards", "request": { "name": "Get Stake Rewards", "description": { "content": "Retrieves the rewards linked to a specific stake.", "type": "text/plain" }, "url": { "path": [ "staking", "stakes", ":stakeId", "rewards" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "stk-qx569-ti9h5-epu8z1bumqmr26", "key": "stakeId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "ffab9668-1d5c-5ce2-b3fe-4bdb6f7bccb4" }, { "name": "Swaps", "description": "", "item": [ { "id": "f57d502c-dd82-520f-99bf-982b81432278", "name": "Create Swap", "request": { "name": "Create Swap", "description": { "content": "Create a new swap based on an existing quote. This is the second step of the [Swap flow](https://docs.dfns.co/api-reference/swaps#flow-overview).", "type": "text/plain" }, "url": { "path": [ "swaps" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quoteId\": \"swapQuote-3hgv4-q8tbf-8v2ajmrbmg6m4i9t\",\n \"reference\": \"optional reference for record keeping\",\n \"provider\": \"UniswapClassic\",\n \"walletId\": \"wa-123456-12345678\",\n \"targetWalletId\": \"wa-123456-87654321\",\n \"slippageBps\": 50,\n \"sourceAsset\": {\n \"kind\": \"Native\",\n \"amount\": \"1000000000000000000\"\n },\n \"targetAsset\": {\n \"kind\": \"Erc20\",\n \"contract\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"amount\": \"5600000\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12eb5537-6883-5c68-9ff6-927e24fa8305", "name": "List Swaps", "request": { "name": "List Swaps", "description": { "content": "List all swaps with pagination", "type": "text/plain" }, "url": { "path": [ "swaps" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28d2db57-f51a-5ee5-aac8-e75764938f33", "name": "Request Swap Quote", "request": { "name": "Request Swap Quote", "description": { "content": "Request a quote from a given provider for swapping assets. This is the first step of the [Swap flow](https://docs.dfns.co/api-reference/swaps#flow-overview).", "type": "text/plain" }, "url": { "path": [ "swaps", "quotes" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"wa-3l3cj-l8mq7-8q78f9nopq7f1qjv\",\n \"targetWalletId\": \"wa-3l3cj-l8mq7-8q78f9nopq7f1qjv\",\n \"provider\": \"UniswapClassic\",\n \"sourceAsset\": {\n \"kind\": \"Native\",\n \"amount\": \"1000000000000000000\"\n },\n \"targetAsset\": {\n \"kind\": \"Erc20\",\n \"contract\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\"\n },\n \"slippageBps\": 50\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "629d1c89-ad5e-560f-8355-9f2677eaec05", "name": "Get Swap", "request": { "name": "Get Swap", "description": { "content": "Get details of a specific swap by its ID", "type": "text/plain" }, "url": { "path": [ "swaps", ":swapId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "swapId", "disabled": false, "description": { "content": "(Required) Id of the swap for which we want to get details.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c59b7f87-50e2-51ba-b853-a040e7c3e6dd", "name": "Get Swap Quote", "request": { "name": "Get Swap Quote", "description": { "content": "Get details of a specific swap quote by its ID", "type": "text/plain" }, "url": { "path": [ "swaps", "quotes", ":quoteId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "quoteId", "disabled": false, "description": { "content": "(Required) The ID of the Swap Quote.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "441d41a9-52d7-5375-a0a5-7d17086f3c2a" }, { "name": "Wallets", "description": "", "item": [ { "name": "Transactions", "item": [ { "id": "d2865605-39e1-5442-a3b7-b0f24b57257c", "name": "Abort Transaction", "request": { "name": "Abort Transaction", "description": { "content": "Aborts a transaction that is currently in 'Executing' status and has not yet been signed. Sets the transaction status to 'Failed' and removes it from the retry queue.\n\n This is useful when a transaction is stuck in the execution pipeline (e.g., during construct or sign phase) and you want to abort it without waiting for it to fail on its own.\n\n Unlike cancel, which creates a replacement on-chain transaction, abort simply marks the transaction as failed without any blockchain interaction.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transactions", ":transactionId", "abort" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Transaction id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fa94dab-2a0c-5214-9c0f-eded6e85f47f", "name": "Sign and Broadcast Transaction", "request": { "name": "Sign and Broadcast Transaction", "description": { "content": "Sign & Broadcast transaction enables communication with any arbitrary smart contract of the target blockchain. You can construct a transaction that performs a complex task and this endpoint will sign the transaction, add the signature and broadcast it to chain. It can be used to call smart contract functions like mint tokens and even deploy new smart contracts.\n\n| Status | Definition |\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| Pending | The request is pending approval due to a policy applied to the wallet. |\n| Executing | The request is approved and is in the process of being executed. note this status is only set for a short time between pending and broadcasted. |\n| Broadcasted | The transaction has been successfully written to the mempool. |\n| Confirmed | The transaction has been confirmed on-chain by our indexing pipeline. |\n| Failed | Indicates either a system failure to complete the request or the transaction failed on chain. |\n| Rejected | The request has been rejected by a policy approval action. |\n\n\n \n for reading from a \"view\" function on EVM chains, please use [Read Contract](https://docs.dfns.co/api-reference/networks/read-contract) endpoint.\n ", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transactions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Eip1559\",\n \"to\": \"0xe5a2ebc128e262ab1e3bd02bffbe16911adfbffc\",\n \"value\": \"1\",\n \"maxFeePerGas\": \"1000000000\",\n \"maxPriorityFeePerGas\": \"1000000\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db07b9fe-86f4-57ec-9a7e-0ae097bbd6d7", "name": "List Transactions", "request": { "name": "List Transactions", "description": { "content": "Retrieves a list of transactions requests for the specified wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transactions" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6f8a977-9f7d-5bdd-ae30-4d4042ff1a6e", "name": "Cancel Transaction", "request": { "name": "Cancel Transaction", "description": { "content": "Cancels an EVM transaction by creating a replacement transaction with the same nonce. The new transaction sends 0 value to the same address, effectively nullifying the original transaction.\n \n This endpoint works for:\n - EVM-compatible networks (Ethereum, Polygon, BSC, etc.)\n - Transactions that are in 'Broadcasted' status (pending inclusion in a block)\n - Transactions that are in 'Failed' status, but failed off-chain (before being broadcasted to the network)\n \n The cancellation works by:\n 1. Extracting the nonce from the original transaction's signed data\n 2. Creating a new transaction to the same wallet address with 0 amount\n 3. Using the same nonce to either:\n - Replace the original transaction in the mempool (if it was broadcasted)\n - Consume the nonce that was reserved but not used (if the transaction failed off-chain)\n \n Note: For transactions that were broadcasted on-chain, success is not guaranteed as it depends on network conditions and whether the original transaction has already been mined.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transactions", ":transactionId", "cancel" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Transaction id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13db7933-706c-5d93-bda3-0c4ad2786b58", "name": "Speed Up Transaction", "request": { "name": "Speed Up Transaction", "description": { "content": "Speeds up a transaction by creating a replacement transaction with the same parameters but higher gas fees.\n \n This endpoint only works for:\n - EVM-compatible networks (Ethereum, Polygon, BSC, etc.)\n - Transactions that are in 'Broadcasted' status (already submitted to blockchain, but not confirmed yet)\n \n The speed-up works by:\n 1. Extracting the parameters from the original broadcasted transaction\n 2. Creating a new transaction with the same nonce, recipient, value, and data\n 3. Using higher gas fees (maximum between 10% bump or Fast network fees)\n 4. Replacing the original transaction in the mempool\n \n Note: Success is not guaranteed as it depends on network conditions and whether the original transaction has already been mined.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transactions", ":transactionId", "speed-up" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Transaction id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c160df1-78bb-5fef-af01-705227d7c826", "name": "Get Transaction", "request": { "name": "Get Transaction", "description": { "content": "Retrieve information about a specific transaction.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transactions", ":transactionId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Transaction id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "1e24c0b2-00d6-5cfa-a8a0-7bed89b25642" }, { "name": "Transfers", "item": [ { "id": "955894c9-638d-5d0d-b6b0-362719068a0c", "name": "Abort Transfer", "request": { "name": "Abort Transfer", "description": { "content": "Aborts a transfer that is currently in 'Executing' status and has not yet been signed. Sets the transfer status to 'Failed' and removes it from the retry queue.\n\n This is useful when a transfer is stuck in the execution pipeline (e.g., during construct or sign phase) and you want to abort it without waiting for it to fail on its own.\n\n Unlike cancel, which creates a replacement on-chain transaction, abort simply marks the transfer as failed without any blockchain interaction.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transfers", ":transferId", "abort" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transferId", "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d7ea69c-06ac-5501-a964-7ab92ce550ca", "name": "Cancel Transfer", "request": { "name": "Cancel Transfer", "description": { "content": "Cancels an EVM transfer by creating a replacement transaction with the same nonce. The new transaction sends 0 value to the same address, effectively nullifying the original transfer.\n \n This endpoint works for:\n - EVM-compatible networks (Ethereum, Polygon, BSC, etc.)\n - Transfers that are in 'Broadcasted' status (pending inclusion in a block)\n - Transfers that are in 'Failed' status, but failed off-chain (before being broadcasted to the network)\n \n The cancellation works by:\n 1. Extracting the nonce from the original transfer's signed data\n 2. Creating a new transaction to the same wallet address with 0 amount\n 3. Using the same nonce to either:\n - Replace the original transaction in the mempool (if it was broadcasted)\n - Consume the nonce that was reserved but not used (if the transfer failed off-chain)\n \n Note: For transfers that were broadcasted on-chain, success is not guaranteed as it depends on network conditions and whether the original transaction has already been mined.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transfers", ":transferId", "cancel" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transferId", "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2374f23-7ec4-517f-9cda-ef2f8b8d1df8", "name": "Speed Up Transfer", "request": { "name": "Speed Up Transfer", "description": { "content": "Speeds up a transfer by creating a replacement transaction with the same parameters but higher gas fees.\n \n This endpoint only works for:\n - EVM-compatible networks (Ethereum, Polygon, BSC, etc.)\n - Transfers that are in 'Broadcasted' status (already submitted to blockchain, but not confirmed yet)\n \n The speed-up works by:\n 1. Extracting the parameters from the original broadcasted transfer\n 2. Creating a new transaction with the same nonce, recipient, value, and data\n 3. Using higher gas fees (maximum between 10% bump or Fast network fees)\n 4. Replacing the original transaction in the mempool\n \n Note: Success is not guaranteed as it depends on network conditions and whether the original transaction has already been mined.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transfers", ":transferId", "speed-up" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transferId", "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bb74bfa-6fd7-5738-a93e-0e467928f099", "name": "Get Transfer", "request": { "name": "Get Transfer", "description": { "content": "Retrieves a Wallet Transfer Request by its ID.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transfers", ":transferId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transferId", "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0ae6765-3faa-5678-aa82-e065ffd5d842", "name": "List Transfers", "request": { "name": "List Transfers", "description": { "content": "Retrieves a list of transfer requests for the specified wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transfers" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e190f163-f1ea-5c48-9fb3-6978f757d705", "name": "Transfer Asset", "request": { "name": "Transfer Asset", "description": { "content": "\nTransfer an asset out of the specified wallet to a destination address.\nFor all fungible token transfers, the transfer amount must be specified in the minimum denomination of that token.\nFor example, use the amount in Satoshi for a Bitcoin transfer, or the amount in Wei for an Ethereum transfer etc.\n\nSee the different options in the Body description below. You can also select your kind of transfers in the payload examples in the different languages.\n\n\nBinance chains users can use ERC transfers for BEP tokens and Native transfers for BNB.\n\n\n\nSome blockchains may require additional steps before the transfer can be completed, such as creating a destination account (e.g., Stellar). Please refer to the specific blockchain documentation for any prerequisites or additional requirements.\n\n ", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "transfers" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) The source wallet id (`wa-...`).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"Native\",\n \"to\": \"0xe5a2ebc128e262ab1e3bd02bffbe16911adfbffb\",\n \"amount\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "65248745-bb5b-5c37-bf34-7b6bc6b2b6cd" }, { "name": "Offers", "item": [ { "id": "838a438a-1fc8-5cd5-b01d-3c13ce3f2217", "name": "Get Offer", "request": { "name": "Get Offer", "description": { "content": "Retrieve information about a specific offer received on your wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "offers", ":offerId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "offer-r32qj-nopui-aec7cpu3lv9jjj51", "key": "offerId", "disabled": false, "description": { "content": "(Required) Offer id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68920ff3-780b-5f4c-82af-f0142f2313c8", "name": "List Offers", "request": { "name": "List Offers", "description": { "content": "List all offers received on a specific wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "offers" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3c7e143-1330-53c6-9bdb-262184b23874", "name": "Accept Offer", "request": { "name": "Accept Offer", "description": { "content": "Accept an offer received on your wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "offers", ":offerId", "accept" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "offer-r32qj-nopui-aec7cpu3lv9jjj51", "key": "offerId", "disabled": false, "description": { "content": "(Required) Offer id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2db2548b-53a7-56e4-b7ba-6026f1be0d5f", "name": "Reject Offer", "request": { "name": "Reject Offer", "description": { "content": "Reject an offer received on your wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "offers", ":offerId", "reject" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } }, { "type": "any", "value": "offer-r32qj-nopui-aec7cpu3lv9jjj51", "key": "offerId", "disabled": false, "description": { "content": "(Required) Offer id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "d51288ef-d6d1-50ea-a465-e0df17dadeb4" }, { "id": "82d27e16-7642-511e-a10a-b609d670935a", "name": "Activate Wallet", "request": { "name": "Activate Wallet", "description": { "content": "Activates a wallet by deploying the account contract on-chain, making it ready for transactions.\n\n This operation is required for wallets on networks where you need to explicitly activate your account on-chain\n before it can be used for transactions.\n\n - **Starknet**: Deploys the account contract using the wallet's public key to initialize the account on the blockchain. No additional parameters required.\n - **Concordium**: Deploys the account using credential deployment information and cryptographic randomness returned by the IDApp.\n - **Canton**: Registers the wallet on a validator. You must specify the `validatorId` to activate the wallet. Before activation, the wallet cannot be used and its address will not have a prefix.\n", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "activate" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "badf4bc4-0916-5eb9-90e4-59d6ed936757", "name": "Proxy a request to the Canton Ledger API", "request": { "name": "Proxy a request to the Canton Ledger API", "description": { "content": "Proxies a request to the Canton Ledger API associated with this wallet, using the validator's OAuth2 credentials. Restricted to a curated allow-list of read-style resources. Used to satisfy the Canton WalletConnect `canton_ledgerApi` method.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "canton", "ledger-api" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet id.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requestMethod\": \"POST\",\n \"resource\": \"string\",\n \"body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8c38bd6-7a54-5ad4-ae7d-40f79ec51770", "name": "Create Wallet", "request": { "name": "Create Wallet", "description": { "content": "Creates a new Wallet associated with the given chain (such as Bitcoin or Ethereum ). Returns a new wallet entity.", "type": "text/plain" }, "url": { "path": [ "wallets" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"network\": \"BitcoinSignet\",\n \"signingKey\": {\n \"scheme\": \"Schnorr\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8241b82-9836-5cee-8c80-4cf938ebdff4", "name": "List Wallets", "request": { "name": "List Wallets", "description": { "content": "Retrieves the list of Wallets in your organization. You can filter the results by owner (either by owner id or owner username). Pagination is supported via limit and paginationToken parameters.", "type": "text/plain" }, "url": { "path": [ "wallets" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": true, "description": { "content": "Filter by owner id or username.", "type": "text/plain" }, "key": "owner", "value": "string" }, { "disabled": true, "description": { "content": "@deprecated use owner instead", "type": "text/plain" }, "key": "ownerId", "value": "string" }, { "disabled": true, "description": { "content": "@deprecated use owner instead", "type": "text/plain" }, "key": "ownerUsername", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b70a09c-6099-586e-9a2e-924fd34b0e0c", "name": "Get Wallet", "request": { "name": "Get Wallet", "description": { "content": "Retrieves a Wallet information by its ID.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) The wallet to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9447c23d-4898-5fd9-80d9-947322ff1c45", "name": "Update Wallet", "request": { "name": "Update Wallet", "description": { "content": "Updates the name of an existing wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f0e1aac-9a55-59db-8e4a-41ad5d7cac1c", "name": "Get Wallet Assets", "request": { "name": "Get Wallet Assets", "description": { "content": "Retrieves a list of assets owned by the specified wallet. Return values vary by chain as shown below.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "assets" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of true)", "type": "text/plain" }, "key": "netWorth", "value": "true" } ], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98880f78-6387-5f8e-9300-973cc8037f0b", "name": "Get Wallet History", "request": { "name": "Get Wallet History", "description": { "content": "Retrieves a list of historical on chain activities for the specified wallet.\n\nThe list reflects the indexed on-chain activity: it includes confirmed transactions only.\n\nIf you need to list your on-going or failed transactions please use the related endpoints (\n[List Transfers](https://docs.dfns.co/api-reference/wallets/list-transfers) or\n[List Transactions](https://docs.dfns.co/api-reference/wallets/list-transactions)\ndepending on the API you are using).", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "history" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": true, "description": { "content": "Transfer direction. (This can only be one of In,Out)", "type": "text/plain" }, "key": "direction", "value": "Out" }, { "disabled": true, "description": { "content": "Blockchain event kind. (This can only be one of NativeTransfer,Aip21Transfer,AsaTransfer,AssetTransfer,Cip56Transfer,Cis2Transfer,Cis7Transfer,CoinTransfer,Erc20Transfer,Erc721Transfer,Erc7984Transfer,HederaErc20Transfer,HederaErc721Transfer,Hip17Transfer,HtsTransfer,IouTransfer,LockedCoinTransfer,Sep41Transfer,Snip2Transfer,Snip3Transfer,SplTransfer,Spl2022Transfer,Tep74Transfer,Trc10Transfer,Trc20Transfer,Trc721Transfer,UtxoTransfer,Xls33Transfer)", "type": "text/plain" }, "key": "kind", "value": "Sep41Transfer" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "contract", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) Wallet you want to get the history from.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68948576-9a2e-5c10-b93f-90dedd16dfb2", "name": "Get Wallet Nfts", "request": { "name": "Get Wallet Nfts", "description": { "content": "Retrieves a list of NFTs owned by the specified Wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "nfts" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "314957c4-945d-5c61-866a-22f19f519441", "name": "Import Wallet", "request": { "name": "Import Wallet", "description": { "content": "\nThis endpoint is not enabled by default. [Contact Dfns](https://support.dfns.co) to have it activated.\n\n\nDfns secures private keys by generating them as MPC key shares in our decentralized key management network. This happens by default when you [create a wallet](https://docs.dfns.co/api-reference/wallets/create-wallet).\n\nIn some circumstances, however, you may need to import an existing wallet (an existing private key) into Dfns infrastructure, instead of creating a brand new wallet with Dfns and transfer funds to it. As an example, you might want to keep an existing wallet if its address is tied to a smart contract which you don't want to re-deploy.\n\nIn such a case, Dfns exposes this wallet import API endpoint, which can be used in conjunction with our [import SDK](https://github.com/dfns/dfns-sdk-ts/tree/m/examples/sdk/import-wallet). Note this is intended to be used only to migrate wallets when first onboarding onto the Dfns platform.\n\n\nDfns can not guarantee the security of imported wallets, as we have no way to control who had access to the private key prior to import. For this reason, this feature is restricted to Enterprise customers who have signed a contractual addendum limiting our liability for imported keys. Please contact your sales representative for more information.\n\n", "type": "text/plain" }, "url": { "path": [ "wallets", "import" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"curve\": \"ed25519\",\n \"protocol\": \"KU23\",\n \"minSigners\": 9851,\n \"encryptedKeyShares\": [\n {\n \"signerId\": \"string\",\n \"encryptedKeyShare\": \"string\"\n }\n ],\n \"network\": \"SeiAtlantic2\",\n \"name\": \"string\",\n \"externalId\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a85fb13c-89be-5e5c-9ffc-d49eabda9113", "name": "Tag Wallet", "request": { "name": "Tag Wallet", "description": { "content": "Add a [Tag](https://docs.dfns.co/api-reference/wallets/tags) to a wallet.", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "tags" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"pHu/36RPcjGzptI:XgrFtO43Jf9ial7rgf-JlQQ699V:.+JAtvx2fF2gi\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2142630f-f956-5adf-97aa-2ac180f30307", "name": "Untag Wallet", "request": { "name": "Untag Wallet", "description": { "content": "Removes the specified tags from a wallet. ", "type": "text/plain" }, "url": { "path": [ "wallets", ":walletId", "tags" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "walletId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"3VCi/OckjW9DB1h:d:dqHKuGCNrIdP1uvjYAQIjJ.wOXAEsnAmb-_pp\",\n \"71v4IfhF9Kc+XcJBSZFjFviF_57lr\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a736eb0-b3ac-5647-8331-d44deec586ae", "name": "List Org Wallet History", "request": { "name": "List Org Wallet History", "description": { "content": "Retrieve the transaction history across all wallets within a specified timeframe. The time range is unbounded, but the CSV export is capped at 100,000 rows.", "type": "text/plain" }, "url": { "path": [ "wallets", "all", "history" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": true, "description": { "content": "Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request.", "type": "text/plain" }, "key": "paginationToken", "value": "string" }, { "disabled": false, "description": { "content": "(Required) [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). Start of the time range to query.", "type": "text/plain" }, "key": "startTime", "value": "1976-08-16T03:45:48.599Z" }, { "disabled": false, "description": { "content": "(Required) [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). End of the time range to query.", "type": "text/plain" }, "key": "endTime", "value": "2004-07-03T16:11:54.013Z" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "c67c0df1-59cd-5cc8-a115-73b029101110" }, { "name": "Webhooks", "description": "", "item": [ { "id": "d70d65ba-4788-5b2e-ac58-58e2ce3613e3", "name": "Create Webhook", "request": { "name": "Create Webhook", "description": { "content": "Register a new webhook.", "type": "text/plain" }, "url": { "path": [ "webhooks" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"events\": [\n \"wallet.transaction.rejected\"\n ],\n \"status\": \"Enabled\",\n \"description\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb890386-d13e-5ff3-ae88-3466fac142d2", "name": "List Webhooks", "request": { "name": "List Webhooks", "description": { "content": "List all webhooks for the authenticated user's organization. The results are paginated.", "type": "text/plain" }, "url": { "path": [ "webhooks" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "56" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0566c758-fa57-5ac0-8493-113ab6b6166f", "name": "Delete Webhook", "request": { "name": "Delete Webhook", "description": { "content": "Deletes an existing webhook registration.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhookId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "webhookId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25ed2e28-c6e3-5dfc-9dfa-a6b6d37efb9a", "name": "Get Webhook", "request": { "name": "Get Webhook", "description": { "content": "Retrieve information about a specific webhook.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhookId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "webhookId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d52e4b0-8103-54ac-a23d-bf7fa2e3c117", "name": "Update Webhook", "request": { "name": "Update Webhook", "description": { "content": "Update the definition of an existing webhook.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhookId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "webhookId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"description\": \"string\",\n \"events\": [\n \"wallet.exported\"\n ],\n \"status\": \"Disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81175b63-f718-5ba6-be42-e0eadc81fd95", "name": "Ping Webhook", "request": { "name": "Ping Webhook", "description": { "content": "This endpoint is meant for webhook setup and troubleshooting. Calling the endpoint will trigger a fake test event that will be pushed to the webhook URL. The fake event will not be saved and not appear in further requests to Webhook Events.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhookId", "ping" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "webhookId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT)", "type": "text/plain" }, "key": "X-DFNS-USERACTION", "value": "VALUE_UPDATED_BY_POSTMAN_PRE_SCRIPT" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d19045da-978f-505b-a0c9-fab357dc689e", "name": "Get Webhook Event", "request": { "name": "Get Webhook Event", "description": { "content": "Retrieve a specific webhook event details by its ID.\n \n\nWe only keep a trace of those Webhook Events in our system for a **retention period of 31 days**. Past that, they are discarded, so you cannot see them using [List Webhook Events](https://docs.dfns.co/api-reference/webhooks/list-webhook-events) or [Get Webhook Event](https://docs.dfns.co/api-reference/webhooks/get-webhook-event) endpoints.\n", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhookId", "events", ":webhookEventId" ], "host": [ "{{dfnsApiDomain}}" ], "query": [], "variable": [ { "type": "any", "value": "wh-am8hw-1qqu5-g3jhvqnwaac07z33", "key": "webhookId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "whe-qey04-50o4j-3i4xoegppd434j", "key": "webhookEventId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "866b57df-3e26-5997-8c15-84e415da3037", "name": "List Webhook Events", "request": { "name": "List Webhook Events", "description": { "content": "Lists all events for a given webhook. \n\n\n\nWe only keep a trace of those Webhook Events in our system for a **retention period of 31 days**. Past that, they are discarded, so you cannot see them using [List Webhook Events](https://docs.dfns.co/api-reference/webhooks/list-webhook-events) or [Get Webhook Event](https://docs.dfns.co/api-reference/webhooks/get-webhook-event) endpoints.\n", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhookId", "events" ], "host": [ "{{dfnsApiDomain}}" ], "query": [ { "disabled": true, "description": { "content": " (This can only be one of policy.triggered,policy.approval.pending,policy.approval.resolved,key.created,key.deleted,key.delegated,key.exported,wallet.blockchainevent.detected,wallet.blockchain_event.transfer.included,wallet.created,wallet.activated,wallet.delegated,wallet.exported,wallet.signature.failed,wallet.signature.rejected,wallet.signature.requested,wallet.signature.signed,wallet.transaction.broadcasted,wallet.transaction.confirmed,wallet.transaction.failed,wallet.transaction.rejected,wallet.transaction.requested,wallet.transfer.broadcasted,wallet.transfer.confirmed,wallet.transfer.failed,wallet.transfer.rejected,wallet.transfer.requested,wallet.offer.received,wallet.offer.accepted,wallet.offer.rejected,wallet.offer.withdrawn,wallet.tags.modified,payout.action.required)", "type": "text/plain" }, "key": "kind", "value": "wallet.delegated" }, { "disabled": true, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "deliveryFailed", "value": "true" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "56" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "paginationToken", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "webhookId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "id": "b191ef14-7ed4-5972-8c01-304e3d167ed7" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/**", " * This script handles this flow. If request is a POST and you use authv2, it will", " * 1. call \"POST /auth/action/init\" to get a user action challenge", " * 2. Sign the challenge with the private key", " * 3. call \"POST /auth/action\" with the signed challenge, to get a \"user action signature\" back (also called \"user action token\")", " * 4. Add this user action signature in the request header (X-DFNS-USERACTION)", " * 5. Add other necessary headers like authToken (Authorization)", " */", "", "window = {};", "navigator = { appName: \"stub\", userAgent: \"stub\" };", "", "function extractBigNum(fullArray, start, end, expectedLength) {", " let num = fullArray.slice(start, end);", " if (num.length !== expectedLength) {", " num = Array(expectedLength).fill(0).concat(...num).slice(num.length);", " }", " return num;", "}", "", "function derToRaw(signature) {", " const rStart = 4;", " const rEnd = rStart + signature[3];", " const sStart = rEnd + 2;", " return new Uint8Array([", " ...extractBigNum(signature, rStart, rEnd, 32),", " ...extractBigNum(signature, sStart, signature.length, 32),", " ]);", "}", "", "function base64url(str, format = undefined) {", " return Buffer.from(str, format).toString(\"base64\")", " .replace(/=/g, \"\")", " .replace(/\\+/g, \"-\")", " .replace(/\\//g, \"_\");", "}", "", "function trySignPayload(signingKey, message, KJUR) {", " const signingAlgos = ['SHA256withECDSA', 'SHA256withRSA']", " let err = undefined", "", " for (const alg of signingAlgos) {", " try {", " const sig = new KJUR.crypto.Signature({ alg });", " sig.init(signingKey);", " sig.updateString(message);", " const signature = base64url(sig.sign(), 'hex');", " return signature", " } catch (e) {", " err = e", " }", " }", "", " console.error(`Error while signing with private key: ${err}`)", " throw err", "}", "", "function signAction() {", " const dfnsApiDomain = pm.variables.replaceIn(pm.request.url.getHost());", "", " // in order to sign in postman, we need this crypto helper library:", " pm.sendRequest(\"https://cdnjs.cloudflare.com/ajax/libs/jsrsasign/8.0.20/jsrsasign-all-min.js\", (err, res) => {", " eval(res.text());", "", " const authToken = pm.environment.get(\"authToken\");", " const signingKey = pm.environment.get(\"credentialPrivateKey\").replace(/\\\\n/g, \"\\n\");", "", " const createSigningChallengeRequest = {", " url: `https://${dfnsApiDomain}/auth/action/init`,", " method: \"POST\",", " header: {", " \"Content-Type\": \"application/json\",", " \"Authorization\": \"Bearer \" + authToken,", " },", " body: {", " mode: \"raw\",", " raw: JSON.stringify({", " userActionPayload: pm.request.body?.raw || '',", " userActionHttpPath: pm.variables.replaceIn(pm.request.url.getPath()),", " userActionHttpMethod: pm.request.method,", " userActionServerKind: 'Api'", " })", " }", " };", " pm.sendRequest(createSigningChallengeRequest, (error, response) => {", " if (error || response.code !== 200) {", " throw new Error(\"Unable to get challenge: \" + response.json().error.message);", " }", " const challenge = response.json();", " const clientData = JSON.stringify({", " type: \"key.get\",", " challenge: challenge.challenge", " });", "", " const signature = trySignPayload(signingKey, clientData, KJUR)", "", " const signedChallenge = {", " kind: \"Key\",", " credentialAssertion: {", " credId: challenge.allowCredentials.key[0].id,", " clientData: base64url(clientData),", " signature: signature", " }", " };", " const createSignatureRequest = {", " url: `https://${dfnsApiDomain}/auth/action`,", " method: \"POST\",", " header: {", " \"Content-Type\": \"application/json\",", " \"Authorization\": \"Bearer \" + authToken,", " },", " body: {", " mode: \"raw\",", " raw: JSON.stringify({", " challengeIdentifier: challenge.challengeIdentifier,", " firstFactor: signedChallenge", " })", " }", " };", " pm.sendRequest(createSignatureRequest, (sigError, sigResponse) => {", " if (sigError || sigResponse.code !== 200) {", " throw new Error(\"Failed to sign request: \" + sigResponse.json().error.message);", " }", " pm.request.headers.upsert({ key: \"X-DFNS-USERACTION\", value: sigResponse.json().userAction });", " });", " });", " })", "}", "", "function main() {", " // if this request needs to be \"user action signed\", perform the user actiuon signing flow with under the hood (using the private key in environmnt)", " if (pm.request.headers.has('X-DFNS-USERACTION')) {", " signAction();", " }", "}", "", "main()" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.dfns.io" } ], "info": { "name": "Dfns API", "description": "version: `1.891.3`\n\n\n\n# Welcome 👋\n\nThis Postman collection holds Dfns API endpoints. For more information, visit:\n\n- [Website](https://www.dfns.co/)\n \n- [API Docs](https://docs.dfns.co)\n- [Postman Docs](https://docs.dfns.co/api-reference/openapi-postman)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": "1.891.3", "_postman_id": "f558ac6e-69df-5c29-85c5-b56a96cc3513" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{authToken}}", "type": "string" } ] } }