aljaz/fiatlink
1
0
Fork 0
mirror of https://github.com/aljazceru/fiatlink.git synced 2025-12-17 05:14:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

auth->session, optional wording

Browse Source
This commit is contained in:
Aljaz Ceru
2023-11-02 10:55:23 +01:00
parent dd76c620b5
commit c93ca581dc
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
FLS01/README.md
View File

@@ -12,7 +12,7 @@ The goal of this specification is to provide standardized API for applications t
## Fiat to Bitcoin
### Wallet verification (optional)
To ensure user's ownership of the withdrawing wallet user can sign a message. Service provides the user with a message and user returns that message or part of the predefined message which the user then returns signed with his public key:
Some jurisdictions require wallet verification by users so this spec supports it within the flow. To ensure user's ownership of the withdrawing wallet user can sign a message. Service provides the user with a message and user returns that message or part of the predefined message which the user then returns signed with his public key:
Example:
```
"node_pubkey": "02765a281bd188e80a89e6ea5092dcb8ebaaa5c5da341e64327e3fadbadcbc686c",
@@ -59,7 +59,7 @@ Alternative options:
| Name | function | status | type |
|----------------|-------------------------------------------------|--------|--------|
| /verify | get secret to verify wallet ownership | required | GET |
| /auth | verify wallet ownership | required | POST |
| /session | verify wallet ownership | required | POST |
| /quote | place order | required | POST |
| /order | place order | required | POST |
| /orders | get order status | required | GET |
@@ -83,16 +83,16 @@ Response:
"expires_on": "2023-09-20T00:25:11.123Z"
}
```
- `token` random string from the provider that needs to be signed with the node pubkey
- `token` random string from the provider that needs to be signed with the node pubkey. Can be empty string if proof of ownership not required
- `session_id` uuid identifiying the client session
### auth
Start a session with signed proof of ownership
### session
Start a session with optional signed proof of ownership. If Proof of Ownership is not required signature can be a random alphanumeric value.
Request:
```
POST /auth
POST /session
{
@@ -110,7 +110,7 @@ Response:
"expires_on": "2023-09-20T00:25:11.123Z"
}
```
- `signature ` token from `/verify` signed by the node
- `signature ` token from `/verify` signed by the node. In case `token` is empty signature can be a random alphanumeric value
- `id` client id (optional)