Get a file upload URL

Issue a presigned URL to upload a customer's identity-related file

curl --request POST \
  --url https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "uploadId": "<string>",
    "url": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "headers": {
      "Content-Type": "image/jpeg",
      "x-goog-content-length-range": "0,10000000"
    }
  }
}

{
  "code": "invalid_request",
  "message": "Invalid request",
  "errors": [
    {
      "message": "<string>",
      "field": "<string>",
      "details": {}
    }
  ]
}

{
  "code": "unauthorized",
  "message": "Not authorized"
}

{
  "code": "forbidden",
  "message": "Forbidden"
}

{
  "code": "not_found",
  "message": "Not found"
}

{
  "code": "conflict",
  "message": "Conflict"
}

POST

platform

customers

{id}

files

upload-url

Issue a presigned URL to upload a customer's identity-related file

curl --request POST \
  --url https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.moonpay.com/platform/v1/customers/{id}/files/upload-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "uploadId": "<string>",
    "url": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "headers": {
      "Content-Type": "image/jpeg",
      "x-goog-content-length-range": "0,10000000"
    }
  }
}

{
  "code": "invalid_request",
  "message": "Invalid request",
  "errors": [
    {
      "message": "<string>",
      "field": "<string>",
      "details": {}
    }
  ]
}

{
  "code": "unauthorized",
  "message": "Not authorized"
}

{
  "code": "forbidden",
  "message": "Forbidden"
}

{
  "code": "not_found",
  "message": "Not found"
}

{
  "code": "conflict",
  "message": "Conflict"
}

Some Platform API capabilities must be enabled on your account by MoonPay before you can call them. If this endpoint returns an unexpected 404, see Capability enablement.

Authorizations

Authorization

string

header

required

Bearer authentication header using an access token.

Example: Authorization: Bearer <accessToken>

Path Parameters

string<uuid>

required

The customer's unique MoonPay identifier.

Body

application/json

Request body for issuing a presigned upload URL for an identity-related file.

fileType

enum<string>

required

Type of file the customer is uploading.

Available options:

drivingLicence,

nationalIdentityCard,

passport,

residencePermit,

selfie,

proofOfAddress,

proofOfIncome

mimeType

enum<string>

required

MIME type of the file being uploaded. Must match the Content-Type header used on the subsequent upload request.

Available options:

image/jpeg,

image/png,

application/pdf

side

enum<string>

Side of the document being uploaded. Required for two-sided file types (drivingLicence, nationalIdentityCard, residencePermit); must be omitted for single-sided file types.

Available options:

front,

back

sourceOfWealth

enum<string>

Source of wealth the file evidences. Required for proofOfIncome; must be omitted for all other file types.

Available options:

salary,

savings,

investments,

cryptoTrading,

companyProfits,

companySale,

propertySale,

soleProprietorIncome,

rentalIncome,

inheritance,

pension

subtype

enum<string>

Document subtype. Required for proofOfIncome and must be permitted for the declared sourceOfWealth; must be omitted for all other file types.

Available options:

payslip,

bankStatement,

accountScreenshot,

companyRegisterScreenshot,

dividendDistributionCertificate,

investmentPortfolioStatement,

invoice,

pensionStatement,

rentalAgreement,

saleContract,

signedLetterFromSolicitorOrTrustee

Response

The request has succeeded.

data

object

required

Presigned URL the partner uses to upload an identity-related file directly to MoonPay storage.

Show child attributes

Documentation

Sessions

Customers

Payment Methods

Assets

Quotes

Transactions

Webhooks

Objects & Types

Authorizations

Path Parameters

Body

Response