Skip to content

Commit fcd4627

Browse files
waldyrioushitmanmcc
authored andcommitted
Fix some typos, plus various small wording and punctuation tweaks
1 parent 0de110e commit fcd4627

7 files changed

Lines changed: 32 additions & 26 deletions

File tree

_authentication.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Authentication
22

3-
Uphold is an OAuth 2.0 compliant service.
3+
Uphold is an [OAuth 2.0](https://oauth.net/2/)-compliant service.
44

55
Partners looking to integrate with our API must [register an application](#registering-an-application).
66
Applications that implement a user-facing web interface, to provide custom functionality for multiple Uphold users, should use the [Web Application Flow](#web-application-flow).
@@ -20,12 +20,18 @@ Or for sandbox applications:
2020

2121
`https://sandbox.uphold.com/authorize/<client_id>`
2222

23+
> Example of an authorization request URL:
24+
25+
```
26+
https://uphold.com/authorize/<client_id>?state=<state_string>&scope=accounts:read%20cards:read
27+
```
28+
2329
Supported query parameters:
2430

2531
Parameter | Required | Description
26-
--------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------
27-
intention | no | Unauthenticated users will be redirected to the `login` page, this behavior can be changed by sending `signup` as the `intention` value.
28-
scope | yes | Permissions to request from the user.
32+
--------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------
33+
intention | no | By default, unauthenticated users will be redirected to the `login` page. This behavior can be changed by sending `signup` as the `intention` value.
34+
scope | yes | Permissions to request from the user. Multiple scopes [should be](https://tools.ietf.org/html/rfc6749#section-3.3) separated by spaces.
2935
state | yes | An unguessable, cryptographically secure random string used to protect against cross-site request forgery attacks.
3036

3137
### Step 2 - Requesting a Token
@@ -92,15 +98,15 @@ Once you have obtained an access token you may call any protected API method on
9298
<aside class="notice">
9399
<strong>Security Notice</strong>: No other method of authentication is supported. For security reasons only the "Authorization" header will be processed.
94100

95-
This prevents attackers from stealing tokens from the user's browser history, logs, referer headers and other unsecure locations when credentials are sent via query URLs.
101+
This prevents attackers from stealing tokens from the user's browser history, logs, referrer headers and other insecure locations when credentials are sent via query URLs.
96102
</aside>
97103

98104
## Client Credentials Flow
99105

100106
Ideal for backend integrations that do not require access to other Uphold user accounts.
101107

102108
For **business usage only** you may choose to use client credentials authentication.
103-
This requires manual approval from Uphold.
109+
This requires [manual approval](#support) from Uphold.
104110

105111
### Creating a Token
106112

@@ -146,7 +152,7 @@ Once you have obtained a client credentials token you may call any protected API
146152
<aside class="notice">
147153
<strong>Security Notice</strong>: No other method of authentication is supported.
148154
For security reasons only the "Authorization" header will be processed.
149-
This prevents attackers from stealing tokens from the user's browser history, logs, referer headers and other unsecure locations when credentials are sent via query URLs.
155+
This prevents attackers from stealing tokens from the user's browser history, logs, referrer headers and other insecure locations when credentials are sent via query URLs.
150156
</aside>
151157

152158
## Personal Access Tokens (PAT)
@@ -270,5 +276,5 @@ curl https://api.uphold.com/v0/me \
270276

271277
You can use Basic Authentication by providing your email and password combination.
272278

273-
If OTP (One-Time Password, also known as Two-Factor Authentication) is required, then you will get a [401 HTTP error](#errors), along with the HTTP headers `OTP-Token: Required` and `OTP-Method-Id: Required`.
274-
In which case, execute the command above again, this time passing your OTP verification code and method id as a headers, like so: `OTP-Token: <OTP-Token>` and `OTP-Method-Id: <OTP-Method-Id>`.
279+
If OTP (One-Time Password, also known as Two-Factor Authentication) is required, then you will get a [401 HTTP error](#errors), along with the HTTP header `OTP-Token: Required` and/or `OTP-Method-Id: Required`.
280+
In which case, execute the command above again, this time passing your OTP verification code and method id as headers, like so: `OTP-Token: <OTP-Token>` and `OTP-Method-Id: <OTP-Method-Id>`.

_entities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ name | The display name of the contact created by joining the first and las
134134
}
135135
```
136136

137-
A currency pair is the combination of two currencies, encoded as two currency codes, e.g. USD, GBP, EUR, concatenated together to represent the current status of converting the first currency into the second.
137+
A currency pair is the combination of two currencies, encoded as two [currency codes](#currencies) concatenated together to represent the current status of converting the first currency into the second.
138138
For example, the currency pair "BTCUSD" represents moving from bitcoin to US dollars.
139139

140140
Each currency pair has four properties:

_tickers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tickers
22

3-
Developers can query at any time the rates we utilize when exchanging one form of value for another.
3+
At any time, you can query the rates we utilize when exchanging one form of value for another.
44
These are expressed in [currency pairs](#currency-pair-object).
55

66
## Get Tickers for Currency
@@ -446,7 +446,7 @@ curl https://api.uphold.com/v0/ticker/USD
446446
}]
447447
```
448448

449-
This method allows developers to find all exchanges rates relative to a given currency.
449+
Lists all exchange rates relative to a given currency.
450450

451451
### Request
452452

@@ -487,7 +487,7 @@ curl https://api.uphold.com/v0/ticker/EUR-USD
487487
}
488488
```
489489

490-
This method allows developers to find the exchange rate of a currency relative to any other currency.
490+
Retrieves the exchange rate of a currency relative to any other currency.
491491

492492
<aside class="notice">
493493
The order of the currencies in the pair affects the output.

_transactions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,11 @@ The first step is to prepare the transaction by specifying:
126126

127127
The following table describes the types of transactions currently supported:
128128

129-
Type | Origin | Destination
130-
---------- | ---------------------------------- | --------------------------------------------------------
131-
deposit | _ACH_, _CARD_ or _SEPA_ account id | Uphold card id
132-
withdrawal | Uphold card id | _ACH_, _SEPA_ or _Bitcoin_ address
133-
transfer | Uphold card id | An email address, an application id or an Uphold card id
129+
Type | Origin | Destination
130+
---------- | ----------------------------------- | --------------------------------------------------------
131+
deposit | ACH, credit card or SEPA account id | Uphold card id
132+
withdrawal | Uphold card id | ACH or SEPA account id, or cryptocurrency address
133+
transfer | Uphold card id | Email address, Application id or Uphold card id
134134

135135
Upon preparing a transaction, a [Transaction Object](#transaction-object) will be returned with a newly-generated `id`, and a status of `pending`.
136136

@@ -777,7 +777,7 @@ This endpoint supports [Pagination](#pagination).
777777
Returns an array of [Transaction Objects](#transaction-object).
778778

779779
<aside class="notice">
780-
Be advised that this method has the potential to return a great deal of data.
780+
Be advised that this method can potentially return a large amount of data.
781781
</aside>
782782

783783
## Get Transaction (Public)

_transparency.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ curl https://api.uphold.com/v0/reserve/statistics
254254
```
255255

256256
To assist developers with tracking the overall status of our Reserve, we provide a summary of all the obligations and assets within it.
257-
Then for convenience's sake we compute the value of each our holdings in all of the currencies we support, making it easy for example to display our total US dollar liabilities, but expressed in Euros.
257+
Then, for convenience's sake, we compute the value of each our holdings in all of the currencies we support, making it easy for example to display our total US dollar liabilities, but expressed in Euros.
258258
For example, a request to fetch a summary will return an array of assets with the following properties:
259259

260260
Property | Description
@@ -354,7 +354,7 @@ Instead, Uphold owes them the $507.51 they exchanged for that bitcoin.
354354
</code></pre>
355355

356356
This transfer of value affects our liabilities immediately and in real-time, and thus is reflected in real-time in the ledger.
357-
But when our obligations to our members change a possible imbalance in our Reserve is introduced.
357+
But when our obligations to our members change, a possible imbalance in our Reserve is introduced.
358358
To compensate for this, we must make changes to the assets as well.
359359
These changes to our assets may or may not happen in real-time.
360360
This would therefore be recorded in our ledger at some point in the future as follows:
@@ -469,7 +469,7 @@ By following these transactions you walk backwards down different paths of the R
469469
### Security and Privacy
470470

471471
All transactions are made public, but specific details about the transaction may be withheld from parties who were not a party to said transaction.
472-
To control this we would require developers to authenticate prior to retrieving privileged information relating to a transaction.
472+
To control this, we require developers to authenticate prior to retrieving privileged information relating to a transaction.
473473

474474
### Deposits
475475

_users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Returns the data associated with the current user.
9191
See the [user object](#user-object) documentation for details about the format of the response.
9292

9393
<aside class="notice">
94-
Be advised that this method has the potential to return a great deal of data.
94+
Be advised that this method can potentially return a large amount of data.
9595
</aside>
9696

9797
### Cards

_webhooks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Webhooks
22

33
For **business usage only** you may choose to use webhooks to get updates in real time instead of having to poll the API.
4-
This requires manual approval from Uphold.
4+
This requires [manual approval](#support) from Uphold.
55

66
A webhooks integration requires the following details:
77

88
* **Subscription URL:** the URL for Uphold to send webhook requests to;
9-
* **Secret:** the secret for Uphold to use to sign all requests and prove they have not been tampered
9+
* **Secret:** the secret for Uphold to use to sign all requests and prove they have not been tampered with
1010
(not the same as the client secret that is used for Uphold's API).
1111

1212
Each webhook uses the following format:
@@ -26,7 +26,7 @@ userId | Unique identifier of the Uphold user that owns the resource.
2626
sha512=040518ad86dd4bea08ba6d23240f53a9f35175bcb3c548e83f33acc792aabcafe29954f92b0e1d6ede9192c851b3ba0768f760f516e168c7b318a17d2714bf52
2727
```
2828

29-
In addition, the request also includes a signature header, that can be used to verify the request body has not been tampered.
29+
In addition, the request also includes a signature header, that can be used to verify the request body has not been tampered with.
3030
That header is built by signing the request body with the previously provided secret, using the SHA512 algorithm.
3131

3232
## Card Updated

0 commit comments

Comments
 (0)