Send a verification code to an address
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>'})
};
fetch('https://api.arcmira.com/v1/signups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.arcmira.com/v1/signups"
payload = { "email": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://api.arcmira.com/v1/signups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>"
}
'{
"next": {
"method": "POST",
"url": "<string>"
},
"expires_in": 123
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}Account
Send a verification code to an address
Starts the signup that ends in an account key, with no key and no login. Sends a 6 digit code to the address, valid for 10 minutes and 5 attempts, and answers 202 with the verify call. Sends are capped at 3 per address per hour, 10 per IP per hour, and 25 per client fingerprint per day; past a cap the response is 429 signup_send_limited with retry_after_seconds and an unlock whose action is this call. An address that already has an account gets a code too; verifying it mints a key on that account. Send { "email": "agent@example.com" }, with an optional "src" naming the surface that sent you.
POST
/
v1
/
signups
Send a verification code to an address
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>'})
};
fetch('https://api.arcmira.com/v1/signups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.arcmira.com/v1/signups"
payload = { "email": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://api.arcmira.com/v1/signups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>"
}
'{
"next": {
"method": "POST",
"url": "<string>"
},
"expires_in": 123
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"reason": "no_credential",
"param": "<string>",
"gate": "rows",
"resource": {
"kind": "media_rows",
"beyond_row": 123
},
"unlock": {
"tier": "<string>",
"url": "<string>",
"offer": null,
"action": {
"kind": "<string>",
"method": "<string>",
"url": "<string>"
}
},
"retry_after_seconds": 123,
"details": {
"quote": {
"quarters": 123,
"rows": 123,
"charge": {
"unit": "rows",
"amount": 123,
"from": "included"
},
"max_on_demand_cents": 123
},
"limit": {
"kind": "plan_credits",
"unit": "credits",
"amount": 123,
"used": 123,
"resets_at": "<string>"
},
"url": "<string>"
}
}
}Authorizations
Body
application/json